diff --git a/readme.md b/readme.md index 4bc90cf..645b815 100644 --- a/readme.md +++ b/readme.md @@ -1,14 +1,37 @@ # Authentication API -This is a RESTful authentication API built using VLang on the back-end and HTML5, CSS3 on the front-end. The following endpoints are available: -- `POST /signup` - creates a new user account -- `POST /login` - logs in an existing user -## Prerequisites -Before getting started, make sure you have installed: -- [V](https://vlang.io) -- A modern web browser (Chrome, Firefox, Safari) -- [SQLite3](https://sqlite.org) -## Getting Started -1. Clone this repository to your local machine -2. Run `v run src` from the project root directory -3. Open http://localhost:8082 in your web browser -4. Use the `/signup` endpoint to register a new user or the `/login` endpoint to authenticate as an existing user \ No newline at end of file + +This is a README file for the Authentication API project. + +## Overview + +The Authentication API is a secure and reliable solution for user authentication in web applications. It provides endpoints for user registration, login, and password reset. + +## Features + +- User registration: Allows users to create new accounts by providing their email address and password. +- User login: Allows users to authenticate themselves by providing their credentials. +- Password reset: Provides a mechanism for users to reset their passwords if they forget them. + +## Installation + +To install and run the Authentication API, follow these steps: + +1. Clone the repository: `https://somegit.dev/libexi01/5.git` +2. Install dependencies: `v install` +3. Start the server: `v run src` + +## Usage + +Once the server is running, you can use the following endpoints: + +- `POST /api/register`: Register a new user. +- `POST /api/login`: Authenticate a user. +- `POST /api/reset-password`: Reset a user's password. +- `GET /signup`: Register a new user through the Web UI. +- `GET /login`: Authenticate a new user through the Web UI. + +For detailed API documentation, refer to the [API documentation](/docs/api.md). + +## Contributing + +Contributions are welcome! If you would like to contribute to the Authentication API project, please follow the guidelines outlined in the [CONTRIBUTING.md](/docs/CONTRIBUTING.md) file. \ No newline at end of file