docs: update README with cli info

mlibrary · Oct 4, 2024 · 68e6f07 · 68e6f07
1 parent 49c6ec8
commit 68e6f07
Showing 1 changed file with 7 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -48,14 +48,15 @@ alembic upgrade heads
 The alembic migrations live in the `aim/digifeeds/database/migrations` folder.
 
 #### Web API for the Database
-To run the api:
+The docker compose `api` service runs the application on port 8000.
 
-In the `/app` folder of the container run:
-```
-uvicorn aim.digifeeds.database.main:app --host 0.0.0.0 --reload
-```
+Assuming docker compose is up for the `aim-py` repository, in the browser go to:
+http://localhost:8000/docs to work with the API.
+
+#### CLI
 
-In the browser go to: http://localhost:8000/docs to work with the API.
+The digifeeds CLI is in the file `aim/cli/digifeeds.py` It has a mix a database
+operations and application operations.
 
 ## Tests