diff --git a/README.md b/README.md new file mode 100644 index 0000000..28dec4f --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# Snippeteer + +## Installation + +to work with the @scode scope you have to add the following line to your npmrc +for this particular one you'll have to add it to the global npmrc stored in your home folder (~/.npmrc) + +```npmrc +@scode:registry=https://npm.scode.ovh +``` + +then install the module using the following command + +```sh +npm i -g @scode/snippeteer +``` + +## Usage + +````sh +snippeteer [snippet] [..args] +``` + +All snippets will be executed relative to your current working directory! + +## Snippets + +### Snippet + +Creates a new snippet template + +```sh +snippeteer snippet [name] +```