Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Zaloog committed Nov 21, 2023
1 parent 606a76c commit 6baf4bd
Show file tree
Hide file tree
Showing 6 changed files with 5 additions and 2 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ and display nice looking tables to the terminal.

- *configfile*: A `pykanban.ini` file gets created on first initialization in your `Home`-Directory.
This can be edited manually or within the kanban-python application. It tracks the location for all your created boards
- Image
![configfile](https://github.com/Zaloog/kanban-python/blob/main/images/image_config.PNG)

- *storage-file for each board*: Each created board comes with its own name and `pykanban.json` file,
which stores all tasks for that board.
Expand All @@ -59,18 +59,21 @@ There are 3 commands available after installation of kanban-python:
```
Is used to create a new kanban board i.e. it asks for a name and then creates a `pykanban.json` file with a Welcome Task.
On first use, it will also create the `pykanban.ini` configfile automatically.
![init_file](https://github.com/Zaloog/kanban-python/blob/main/images/image_kanban_init.PNG)

### Interact with Tasks/Boards
```bash
kanban
```
This is your main command to interact with your boards and tasks. It also gives the option to show the current settings and adjust them.
Adjusting the settings can also be done directly by using the 3rd command which is:
![kanban](https://github.com/Zaloog/kanban-python/blob/main/images/image_kanban.PNG)

### Change Settings
```bash
kanban configure
```
![settings](https://github.com/Zaloog/kanban-python/blob/main/images/image_kanban_configure.PNG)

<!-- pyscaffold-notes -->

Expand Down
Binary file added images/image_config.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/image_kanban.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/image_kanban_configure.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/image_kanban_init.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/kanban_python/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ def move_first_done_task_to_archive(data: dict):


def delete_json_file(db_path) -> None:
path = Path(db_path / "pykanban.json")
path = Path(Path(db_path) / "pykanban.json")
try:
path.unlink()
console.print(f"File under {path} was now removed")
Expand Down

0 comments on commit 6baf4bd

Please sign in to comment.