diff --git a/README.md b/README.md index 1b8a4a3..9b801f7 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ # fastapi-new -Create a new FastAPI project in one command. - -✨ Coming soon! ✨ +Create a new FastAPI project in one command. ✨ Test @@ -17,6 +15,40 @@ Create a new FastAPI project in one command. Supported Python versions +## How to use + +Install [uv](https://docs.astral.sh/uv/getting-started/installation/) following their guide for your system. + +Run: + +```bash +uvx fastapi-new awesomeapp +``` + +This will create a new project `awesomeapp` with a basic FastAPI app, configured with uv. + +Enter the directory: + +```bash +cd awesomeapp +``` + +Run the development server: + +```bash +uv run fastapi dev +``` + +Open your browser and go to `http://localhost:8000` to see your new FastAPI app running! 🚀 + +### Existing directory + +If you want to create a new FastAPI project in an existing directory, run the command without a project name: + +```bash +uvx fastapi-new +``` + ## License This project is licensed under the terms of the MIT license.