Skip to content

Commit d5fbcc5

Browse files
committed
docs: Add uvx/pip install instructions to README
1 parent d9ac5d6 commit d5fbcc5

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

Readme.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,27 @@ flAPI is a powerful service that automatically generates read-only APIs for data
1414
- **Security**: Implement row-level and column-level security with ease
1515
- **Easy deployment**: Deploy flAPI with a single binary file
1616

17+
## 📦 Install
18+
19+
The fastest way to try flAPI — no download, no Docker:
20+
21+
```bash
22+
# Run the flapi server (note: "flapi" is taken on PyPI, so the package is "flapi-io")
23+
uvx --from flapi-io flapi -c flapi.yaml
24+
25+
# Run the flapii CLI client
26+
uvx flapii
27+
```
28+
29+
Or install permanently:
30+
31+
```bash
32+
pip install flapi-io # flapi server
33+
pip install flapii # flapii CLI client
34+
```
35+
36+
Pre-built binaries and Docker images are also available — see below.
37+
1738
## 🛠 Quick Start
1839
The easiest way to get started with flAPI is to use the pre-built docker image.
1940

0 commit comments

Comments
 (0)