diff --git a/README.md b/README.md index 284bc27..6dfc170 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,27 @@ # skratch -A cli program to create and edit temporary files +# Skratch -Installation: +A cli program to quickly create and edit temporary files -mv skratch.py /usr/bin/skratch +Requirements: +python3 > 3.6 + +## Installation: + + mv skratch.py /usr/local/bin/skratch + chmod +x /usr/local/bin/skratch set an env variable for $EDITOR and/or $VISUAL in .bashrc -export EDITOR=vi -export VISUAL=geany + export EDITOR=vi + export VISUAL=geany + + + +## Usage +`skratch` creates a random file in .skratch and opens it in the EDITOR +`-c` clears/deletes all files in .skratch +`-l` lists files in .skratch +`-o ` opens a specific file +`-v` opens the VISUAL editor