Skip to content

Commit be4baea

Browse files
authored
Improve the README formatting
1 parent 0b11d91 commit be4baea

File tree

1 file changed

+8
-20
lines changed

1 file changed

+8
-20
lines changed

README.md

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,47 +17,35 @@ This is just one tool in the chain. `notes` is a command line tool, and some peo
1717

1818
Download `notes`, `chmod +x`, put it in your `$path`. This will probably do it:
1919

20-
```
20+
```bash
2121
curl https://cdn.rawgit.com/pimterry/notes/v0.1.0/notes > /usr/local/bin/notes
2222
```
2323

2424
By default your notes live in ~/notes, but you can change that to anywhere you like by setting the `$NOTES_DIRECTORY` environmental variable.
2525

2626
## How do I use it?
2727

28-
```
29-
notes new <note-name>
30-
```
28+
### `notes new <note-name>`
3129

3230
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.
3331

34-
```
35-
notes find <part-of-a-note's-name>
36-
```
32+
### `notes find <part-of-a-note-name>`
3733

3834
Searches note filenames and paths for the given string, and returns all the matches.
3935

40-
```
41-
notes grep <part-of-a-note's-content>
42-
```
36+
### `notes grep <part-of-some-note-content>`
4337

4438
Searches all note content for the given string and returns all the matches.
4539

46-
```
47-
notes open
48-
```
40+
### `notes open`
4941

5042
Opens your notes folder in your default configured file explorer.
5143

52-
```
53-
notes open <note-name>
54-
```
44+
### `notes open <note-name>`
5545

5646
Opens a given note in your `$EDITOR`. Name can be an absolute path, or a relative path in your notes (.md suffix optional).
5747

58-
```
59-
notes grep/find <pattern> | notes open
60-
```
48+
### `notes grep/find <pattern> | notes open`
6149

6250
Combine these together! This opens each matching note in your `$EDITOR` in turn.
6351

@@ -89,4 +77,4 @@ If you submit a PR, please make sure it:
8977

9078
* Doesn't break existing tests
9179
* Adds new tests, if appropriate
92-
* Adds new documentation, if appropriate
80+
* Adds new documentation, if appropriate

0 commit comments

Comments
 (0)