diff --git a/README.md b/README.md index 7491254..0cc4aec 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,21 @@ # Scripts +Personal BASH scripts for productivity + ## Setup 1. clone the repo ```bash $ git clone git@git.sr.ht:~ayoayco/scripts ``` -2. update your .bashrc to add an alias for the parent command in scripts/ayo.sh +2. update your .bashrc to add an alias for the parent command `scripts/ayo.sh` + +## Scripts + +1. ayo - parent command, lists all available scripts or accepts parameters +2. journal - creates a new journal entry if it doesn’t exist yet; opens on editor + +## Planned + +1. config - create configuration for variables (eg, editor, locations) +2.