~porcellis/t

81cdda0707fd3254ca6ece083bc3a5165dd0275a — Pedro Lucas Porcellis 2 months ago c87b79b
Improve README, add todo list and how contribute

Also add todo list and a link to the license.
1 files changed, 29 insertions(+), 11 deletions(-)

M README.md
M README.md => README.md +29 -11
@@ 5,11 5,11 @@

## Philosophy

Instead of using a web editor or something like an web editor, or an
fully bloated app to take your notes and store them on someone's server
with their proprietary software and APIs we choose to use something way
more simple, a combination of bunch of very well documented and trusted
tools, *git* and *markdown*.
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*.

## Design



@@ 23,24 23,42 @@ note to the configured git server. That's it.

## Usage

`t` uses a word to handle it's actions.
`t` is POSIX compliant, meaning that it uses a letter to handle it's actions.

- `l` will list your notes by it's modification date
- `c` will create a new note using the current date. You can supply
a title
a title in quoted strings
- `e` will edit a note, by default it will edit the last one. You can
supply an number to be the index.
supply a position of the index you want to edit.

You can check the man page `man t`

## Contributing

Send me an email at
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!

Send me your patches to my email at
[pedrolucasporcellis@gmail.com](mailto:pedrolucasporcellis@gmail.com)

## License
(Remember to use [plain text](https://useplaintext.mail))!

GNU GPL v3 License

## TODO

There's a lot of things I want to implement on `t`, heres some of them:

- Add a improved visualization when displaying notes
- Delete a note
- Make setup through `t` (`t init` and create the repository, etc).
- Add PGP support on notes
- Allow editing by title of note

## License

GNU GPL v3 License. Check
[LICENSE](https://git.sr.ht/~porcellis/t/tree/master/LICENSE).