Update README.md

README.md

@@ -1,5 +1,7 @@
 # GetEndpoints
 
+This REST API is for managing WebRTC endpoint streams. It is designed for a Unity app running on the HoloLens, where typing and changing settings can be slow and frustrating. Instead of hardcoding endpoints and having to redeploy the app whenever changes are needed, this API provides a single source of truth (SSOT). You can easily update the endpoints whenever you want, making it simple to manage without hassle.
+
 ## Prerequisites
 
 - `python >= 3.11`
@@ -7,12 +9,26 @@
 
 ## Usage
 
-1. Open the terminal.
+1. Create your `src/.env` file according to your requirements. You can copy `src/.env.dev` as a reference.
 
-2. Navigate to the project directory.
-
-3. Run the application:
+2. Run the application:
 
    ```bash
    bash run.sh
    ```
+
+   or, if you are on Windows
+
+   ```ps
+   .\start.bat
+   ```
+
+### Endpoints
+
+- `GET /api/endpoints`: Get the list of all WebRTC endpoints.
+- `GET /api/endpoints/{id}`: Get a specific endpoint by ID.
+- `PUT /api/endpoints/{id}`: Update an existing endpoint.
+
+## API host
+
+By default, this API expects `windows.local` to be an existing DNS record on your DNS server (which could also be defined in your hosts file). If you don't want to use `windows.local`, update the `API_HOST` in your `.env` file.