diff --git a/README.md b/README.md new file mode 100644 index 0000000..832a013 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# ion-cli + +## Installation Instructions +1. clone this repo +2. run `npm install -g` + +## Running Instructions +run using `ion --instruction` + +## Notes +* If you have trouble with windows running the script, try using `Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser` + +# Specific Commands +## Anime +run using `ion --anime` +### arguments +* `-name="name"`: The name of the anime you want to watch +* `-episode=#`: The number of the episode you want to watch - ***OPTIONAL***