Documentation and license information added.

2019-07-12 19:19:12 -04:00
parent 2e1ce6d1c3
commit 95067d490b
2 changed files with 689 additions and 1 deletions
--- a/README.md
+++ b/README.md
@@ -1,3 +1,17 @@
 # notestorm

-Easy notes for the  CLI.
+_Easy notes_ for the  CLI.
+
+## Requirements
+
+- dialog
+- w3m, elinks, or lynx
+- Markdown, in Arch Linux provided by the program discount
+
+## Usage
+
+In its simplest form, just call notestorm with no arguments. You can use all features like this.
+
+## Arguments
+
+- -n --new: Add a new note without bringing up the user interface.