diff --git a/README.md b/README.md index f498073..dcd38eb 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,45 @@ -Run this command to install note to your path. - ### Installation +Run this command in your terminal to install note to your path. `sudo ./note-install` + ### Usage + `note [--setfile ] [--less|--vi|--gedit|--help|--author|--version]` -`note [text]` - will one row of text to the notefile. -`note less` - will show everything in the notefile with the `less`-command. +### Commands + `--setfile:` Set new temporary location of file -`note` - will let you type anything until a command is entered. + `--less` Show contents using "less" + + `--vi` Edit contents using "vi" + + `--gedit` Edit contents using "gedit" + + `--location` Show file location + + `--help` Show this help message + + `--author` Show the author + + `--version` Show current version + + +### Examples + `note [leave empty or a command]` + Just like --setfile, but default value '$filename'. + + `note This is a message that will be added to the notefile with date.` + You can create notes that are one line by directly typing it after note. + + `note --setfile [leave empty or a command]` + Will open note just as before, but using instead. + ### Commands -`:q` - exit +`:q` - exit the program -`:exit` - exit +`:exit` - exit the program `:less` - will show the notefile with the `less` command.