Skip to content

Commit 3cde479

Browse files
authored
docs(readme): reorganise installation section (#72)
Move pip/uv installation to the top as the primary method. Relocate Nix development setup to a new "Development" section at the bottom, making it clear Nix is for contributors. Also add direnv allow instruction for automatic environment activation.
1 parent cac2d56 commit 3cde479

1 file changed

Lines changed: 27 additions & 24 deletions

File tree

README.md

Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -29,30 +29,6 @@ StackOne AI provides a unified interface for accessing various SaaS tools throug
2929

3030
## Installation
3131

32-
### Using Nix (Recommended for Development)
33-
34-
If you have [Nix](https://nixos.org/) installed with flakes enabled:
35-
36-
```bash
37-
# Enter development environment (auto-installs dependencies and git hooks)
38-
nix develop
39-
40-
# Format code
41-
nix fmt
42-
43-
# Run checks
44-
nix flake check
45-
```
46-
47-
The Nix development environment includes:
48-
49-
- Python with uv package manager
50-
- Automatic dependency installation
51-
- Git hooks (treefmt + ty) auto-configured
52-
- Consistent environment across all platforms
53-
54-
### Using pip/uv
55-
5632
```bash
5733
pip install 'stackone-ai[mcp]'
5834

@@ -357,6 +333,33 @@ For more examples, check out the [examples/](examples/) directory:
357333
- [CrewAI Integration](examples/crewai_integration.py)
358334
- [Meta Tools](examples/meta_tools_example.py)
359335

336+
## Development
337+
338+
### Using Nix (Recommended)
339+
340+
[Nix](https://nixos.org/) with flakes provides a consistent development environment:
341+
342+
```bash
343+
# Enter development environment (auto-installs dependencies and git hooks)
344+
nix develop
345+
346+
# Or with direnv (recommended for automatic activation)
347+
direnv allow
348+
349+
# Format code
350+
nix fmt
351+
352+
# Run checks
353+
nix flake check
354+
```
355+
356+
The Nix development environment includes:
357+
358+
- Python with uv package manager
359+
- Automatic dependency installation
360+
- Git hooks (treefmt + ty) auto-configured
361+
- Consistent environment across all platforms
362+
360363
## License
361364

362365
Apache 2.0 License

0 commit comments

Comments
 (0)