Skip to content

Commit b7df8e5

Browse files
committed
docs: better description, adding a planned feature
1 parent b6d0e4b commit b7df8e5

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# mynd
22

3-
Yet another todo app, because I'm opinionated about the dumbest things.
3+
_Yet another todo app_.
4+
5+
A [very] simple todo list management cli tool for developers, with an optional gui. The fastest way I've found to go from needing to write something quickly (i.e during a meeting)
6+
to having it written down.
47

58
![image](https://github.com/Gnarus-G/mynd/assets/37311893/69358ce2-5711-4f5b-a8be-cb989ec0c112)
69

@@ -11,6 +14,7 @@ Yet another todo app, because I'm opinionated about the dumbest things.
1114
- [x] Local Persistence Option
1215
- [x] Soft Delete Done Items
1316
- [x] Permanent Deletion (Drap-n-drop to trash bin)
17+
- [ ] Todo Language & LSP
1418
- [ ] Remind Command: /r (Desktop Notifications)
1519
- [ ] Remote Persistence Option
1620

@@ -31,20 +35,24 @@ Find the executables in the [releases](https://github.com/Gnarus-G/mynd/releases
3135

3236
## Usage
3337

34-
Start up the GUI.
38+
### CLI
39+
40+
At any point you can pull up your terminal and add a todo item like so.
3541

3642
```sh
37-
todo gui
43+
todo "todo message"
3844
```
3945

40-
Or just call `mynd` directly, which is what `todo gui` does.
46+
### GUI
4147

42-
At any point you can pull up your terminal and add a todo item like so.
48+
Start up the GUI.
4349

4450
```sh
45-
todo "todo message"
51+
todo gui
4652
```
4753

54+
Or just call `mynd` directly, which is what `todo gui` does.
55+
4856
Very convenient when your manager is rapping requirements at you during a meeting.
4957

5058
```

0 commit comments

Comments
 (0)