Author: Pedro Lucas Porcellis <pedrolucasporcellis@gmail.com>
Little adjustments on the README
README.md | 33 ++++++++++++++++++---------------
diff --git a/README.md b/README.md index a46f14efcf5cd8ae4b16615d1c54fd5244453024..27c5cd6927262961197ed0680adc7f88974a0b85 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,14 @@ # t - `t` is an minimalistic tool to take notes. ## Philosophy Instead of using a web editor or some native app that under the hood is -a web page, or even a fully bloated app to take your notes and store -it on someone elses server with their proprietary software and APIs we -choose to use something way more simple, a combination of two very -well documented, free and trusted tools: *git* and *markdown*. +a web page, or even a fully bloated app to take your notes and store it +on someone elses server with their proprietary software and APIs we +rather choose to use something way more simple, a combination of two +very well documented, free and trusted tools: *git* and *markdown*. ## Design @@ -25,11 +24,15 @@ ## Usage `t` has a small set of commands: -- `list` or `l` will list your notes by it's modification date +- `list` or `l` will list your notes indexed by it's modification date, +while piping to the default `PAGER` on your system (usually `less (1)`). + - `create` or `c` will create a new note using the current date. You can supply a title in quoted strings -- `edit` or `e` will edit a note, by default it will edit the last one. You can -supply a position of the index you want to edit. + +- `edit` or `e` will reopen the note on your `EDITOR`, by default it +will edit the last one. You can supply the index of the note you want to edit. + - `show` or `s` will pipe the note to [glow](https://github.com/charmbracelet/glow) You can check the man page `man t` if you need any help. @@ -54,12 +57,12 @@ The plain, good and old git-way of contributing. The only dependency is `go`, which you can install trough your package -manager (apk on Alpine, pacman on Arch, apt on Debian-based etc). After -that, you can use `make get` to fetch all dependencies and start -hacking! +manager (apk on Alpine, pacman on Arch, apt on Debian-based distros +etc). After that, you can use `make get` to fetch all dependencies and +start hacking! -Send me your patches to my email at -[pedrolucasporcellis@gmail.com](mailto:pedrolucasporcellis@gmail.com) +Send your patches to my public-inbox at +[~porcellis/public-inbox@lists.sr.ht](mailto:~porcellis/public-inbox@lists.sr.ht) (Remember to use [plain text](https://useplaintext.email))! @@ -74,9 +77,9 @@ - Delete a note - Make setup through `t` (`t init` would create the notes repository, set a remote, etc). - Add PGP support for notes (this is a must) - Allow editing by title of note -- Companion app [tw](https://git.sr.ht/~porcellis/tw) +- Companion UI app [tw](https://git.sr.ht/~porcellis/tw) ## License -GNU GPL v3 License. Check +Under terms of the GNU GPL-3.0 License. Check [LICENSE](https://git.sr.ht/~porcellis/t/tree/master/LICENSE).