Skip to content

Commit cea24de

Browse files
committed
fix: update readme examples
1 parent 6f2f763 commit cea24de

File tree

2 files changed

+5
-14
lines changed

2 files changed

+5
-14
lines changed

README.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,6 @@ A cli framework with the simplicity of argparse, the colors of rich, the config
1212
pip install nanocli
1313
```
1414

15-
## Core Model
16-
17-
```text
18-
CLI = YAML Tree
19-
├── commands (leaf nodes)
20-
└── groups (subtrees)
21-
```
22-
2315
## Quick Start
2416

2517
```python
@@ -53,10 +45,9 @@ python app.py train.epochs=200 -p
5345

5446
# Print config: -p (local), -g (global from root)
5547
python app.py train -p
56-
python app.py data download -g
5748

5849
# Load YAML config
59-
python app.py -c config.yml train
50+
python app.py -c examples/train_config.yml train
6051

6152
# Help
6253
python app.py -h
@@ -81,8 +72,8 @@ def download(cfg: DownloadConfig):
8172

8273
```bash
8374
python app.py data download
84-
python app.py data download dataset=coco -p
85-
python app.py data download dataset=coco -g # prints full tree
75+
python app.py data download path=/data -p
76+
python app.py data download -g # prints full tree from root
8677
```
8778

8879
## Flags
@@ -100,8 +91,6 @@ python app.py data download dataset=coco -g # prints full tree
10091
make dev # Install with dev deps
10192
make test # Run tests
10293
make pre-commit # Run all checks
103-
make lint-fix # Fix lint issues
104-
make type-check # Type check
10594
```
10695

10796
## License

examples/train_config.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
epochs: 200
2+
lr: 0.002

0 commit comments

Comments
 (0)