Skip to content

Commit

Permalink
Update Readme for new Release v0.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Zaloog committed Jan 4, 2025
1 parent 98206d5 commit 5bb54aa
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## v0.6.0
- Add Confirmation prompt to database and config deletion
- Add serving on localhost via `textual-serve` with new`--web`-flag
- Fix Bug in Overview Daterange Creation

## v0.5.0
- Add Footer to Task Edit and Shortcut to save/edit Task
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,10 +99,19 @@ uv tool install kanban-tui
```
I recommend using [pipx], [rye] or [uv] to install CLI Tools into an isolated environment.

To be able to use `kanban-tui` in your browser with the `--web`-flag, the optional dependency
`textual-serve` is needed. You can add this to `kanban-tui` by installing the optional `web`-dependency
with the installer of your choice, for example with [uv]:

```bash
uv tool install kanban-tui[web]
```


## Usage
### Normal Mode
Starts `kanban-tui` with a starting board. The application can be closed by pressing `ctrl+q`.
Pass the `--web` flag and follow the shown link to open `kanban-tui` in your browser.
```bash
ktui
```
Expand All @@ -112,6 +121,7 @@ Creates a temporary Config and Database which is populated with example Tasks to
Kanban-Tui will delete the temporary Config and Database after closing the application.
Pass the `--clean` flag to start with an empty demo app.
Pass the `--keep` flag to tell `kanban-tui` not to delete the temporary Database and Config.
Pass the `--web` flag and follow the shown link to open `kanban-tui` in your browser.

```bash
ktui demo
Expand Down
2 changes: 2 additions & 0 deletions src/kanban_tui/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -493,4 +493,6 @@ def get_time_range(
case "week":
return list(rrule(freq=WEEKLY, dtstart=start, until=end))
case "month":
# Still a bit buggy
# doesnt show task for jan25 when color hue is active
return list(rrule(freq=MONTHLY, dtstart=start, until=end))

0 comments on commit 5bb54aa

Please sign in to comment.