Update docs
This commit is contained in:
parent
70bee705dd
commit
35035feba4
3 changed files with 5 additions and 10 deletions
11
README.md
11
README.md
|
|
@ -4,14 +4,9 @@ A todo utility - enhanced
|
|||
|
||||
## Usage
|
||||
|
||||
You should have `uv` installed or have `virtualenv` or `venv` already set up, and using python 3.12+
|
||||
|
||||
Run (assuming you are using `uv`):
|
||||
|
||||
```shell
|
||||
uv venv
|
||||
source .venv/bin/activate
|
||||
uv sync
|
||||
pip install ajal-todo-cli
|
||||
ajal-todo --help
|
||||
```
|
||||
|
||||
Now you can run commands, start by running `uv run todo.py --help` and continue from there
|
||||
And move forward from there
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
from .app import cli
|
||||
from app import cli
|
||||
|
||||
cli()
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[project]
|
||||
name = "ajal-todo-cli"
|
||||
version = "0.1.0"
|
||||
version = "0.1.1"
|
||||
description = "Add your description here"
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.12"
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue