Skip to content

Commit ec5bbd9

Browse files
committed
Lots of README updates to match new recent changes
1 parent d72bdfe commit ec5bbd9

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ By default your notes live in ~/notes, but you can change that to anywhere you l
2929
notes new <note-name>
3030
```
3131

32-
Opens your $EDITOR of choice for a new note, with the given name. The name can include slashes, if you want put your note in a subfolder.
32+
Opens your `$EDITOR` of choice for a new note, with the given name. The name can include slashes, if you want put your note in a subfolder.
3333

3434
```
3535
notes find <part-of-a-note's-name>
@@ -41,25 +41,37 @@ Searches note filenames and paths for the given string, and returns all the matc
4141
notes grep <part-of-a-note's-content>
4242
```
4343

44-
Search all note content for the given string and returns all the matches.
44+
Searches all note content for the given string and returns all the matches.
4545

4646
```
4747
notes open
4848
```
4949

5050
Opens your notes folder in your default configured file explorer.
5151

52+
```
53+
notes open <note-name>
54+
```
55+
56+
Opens a given note in your `$EDITOR`. Name can be an absolute path, or a relative path in your notes (.md suffix optional).
57+
58+
```
59+
notes grep/find <pattern> | notes open
60+
```
61+
62+
Combine these together! This opens each matching note in your `$EDITOR` in turn.
63+
5264
## Tell me of the future
5365

5466
All the above works. Here's what's coming next:
5567

56-
- [ ] Note edit command
57-
- [ ] Combining find and grep, to match either one
58-
- [ ] Pipe filenames (from `notes find` or `notes grep` or anything else) to `notes open` to open all matching notes
68+
- [ ] Combining find and grep, to match anything one
69+
- [ ] More interesting and nicer looking file/grep search result formatting (...only when not piping?)
70+
- [ ] Make the file extension optional
5971
- [ ] Bash/zsh command autocompletion
6072
- [ ] Bash/zsh note name autocompletion
61-
- [ ] Shorthand aliases `notes o`, `notes g`, `notes n`
62-
- [ ] Interactive mode: `notes` should open a scrollable list of notes, open your editor when you pick one, and reappear after you close it.
73+
- [ ] Shorthand aliases `notes o`, `notes g`, `notes n`
74+
- [ ] Interactive mode? `notes` could open a scrollable list of notes, open your editor when you pick one, and reappear after you close it.
6375

6476
## I want to help
6577

0 commit comments

Comments
 (0)