diff --git a/README.md b/README.md index 17334dd..489ab8a 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,21 @@ Similar to Django, first run: ohmyapi makemigrations [ ] # no app means all INSTALLED_APPS ``` -And the apply your migrations via: +This will create a `migrations/` folder in you project root. + +``` +myproject/ + - myapp/ + - __init__.py + - models.py + - routes.py + - migrations/ + - myapp/ + - pyproject.toml + - settings.py +``` + +Apply your migrations via: ``` ohmyapi migrate [ ] # no app means all INSTALLED_APPS @@ -139,6 +153,7 @@ ohmyapi shell ## Authentication A builtin auth app is available. + Simply add `ohmyapi_auth` to your INSTALLED_APPS and define a JWT_SECRET in your `settings.py`. Remember to `makemigrations` and `migrate` for the auth tables to be created in the database.