@abcnews/aunty 17.0.0-next.5 → 17.0.0-next.6

package/CONTRIBUTING.md

@@ -9,18 +9,31 @@ git clone git@github.com:abcnews/aunty.git
 ...then, from the project directory, run:
 
 ```bash
+npm run build
 npm link
 ```
 
-This will link the globally-available `aunty` command to your clone.
+This will link the globally-available `aunty` command to your clone. While developing, run:
 
-To revert to your original global install, run:
+```bash
+npm run watch
+```
+
+to compile changes to the `dist/` directory automatically.
+
+To revert and uninstall the locally linked version, run:
+
+```bash
+npm uninstall -g @abcnews/aunty
+```
+
+To reinstall the latest published registry version:
 
 ```bash
-npm unlink
+npm install -g @abcnews/aunty
 ```
 
-For ease of use, you can use the Aunty version directly with `node <path to aunty repo> -h`.
+For ease of use, you can use the Aunty version directly with `node <path to aunty repo>/dist/bin/aunty.js -h`.
 
 ## Releasing new versions of `@abcnews/aunty`
 

package/README.md

@@ -21,6 +21,20 @@ Aunty uses the pattern of "helpers" to abstract complex logic out and hopefully
 
 The main CLI logic is in [src/bin/commander.ts](./src/bin/commander.ts).
 
+# Developing
+
+To develop on Aunty, run the watch command to compile your changes in real-time:
+
+```bash
+npm run watch
+```
+
+Or build the project manually:
+
+```bash
+npm run build
+```
+
 See [CONTRIBUTING.md](./CONTRIBUTING.md) for specifics.
 
 # Templates