update readme
This commit is contained in:
parent
9fe928b753
commit
ed4684d8dc
1 changed files with 10 additions and 10 deletions
20
README.md
20
README.md
|
@ -5,7 +5,7 @@ noted is a minimalistic command line note manager written in C.
|
||||||
![](https://r2.e-z.host/3c62bb3a-a8a9-43f6-afd6-553646f51dc4/lzwqimtg.png)
|
![](https://r2.e-z.host/3c62bb3a-a8a9-43f6-afd6-553646f51dc4/lzwqimtg.png)
|
||||||
|
|
||||||
# Usage
|
# Usage
|
||||||
```
|
```sh
|
||||||
Usage: ./noted [-l] [-i] [-v] [-h]
|
Usage: ./noted [-l] [-i] [-v] [-h]
|
||||||
./noted [-I|-Q|-R|-S] [filename]
|
./noted [-I|-Q|-R|-S] [filename]
|
||||||
noted is a minimalistic command line note manager written in C.
|
noted is a minimalistic command line note manager written in C.
|
||||||
|
@ -20,6 +20,15 @@ Options:
|
||||||
-S [filename] Prints the content of the note specified in the filename.
|
-S [filename] Prints the content of the note specified in the filename.
|
||||||
```
|
```
|
||||||
|
|
||||||
|
# Features
|
||||||
|
- Uses EDITOR environment variable to open notes
|
||||||
|
- Respect XDG variables
|
||||||
|
- Search notes by name with interactive prompt
|
||||||
|
- Add, remove, and list notes
|
||||||
|
- Customizable
|
||||||
|
- Supports org, txt, markdown and html format
|
||||||
|
- Generate boilerplate for notes for different formats
|
||||||
|
|
||||||
# Dependencies
|
# Dependencies
|
||||||
|
|
||||||
None
|
None
|
||||||
|
@ -31,15 +40,6 @@ $ make
|
||||||
# make install
|
# make install
|
||||||
```
|
```
|
||||||
|
|
||||||
# Features
|
|
||||||
- Uses EDITOR environment variable to open notes
|
|
||||||
- Respect XDG variables
|
|
||||||
- Search notes by name with interactive prompt
|
|
||||||
- Add, remove, and list notes
|
|
||||||
- Customizable
|
|
||||||
- Supports org, txt, markdown and html format
|
|
||||||
- Generate boilerplate for notes for different formats
|
|
||||||
|
|
||||||
# Notes
|
# Notes
|
||||||
noted will use the editor defined in the `EDITOR` environment variable to open notes. If `EDITOR` is not defined, you will need to define it in your shell configuration file.
|
noted will use the editor defined in the `EDITOR` environment variable to open notes. If `EDITOR` is not defined, you will need to define it in your shell configuration file.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue