devgrowth 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,6 +4,19 @@ Zero-friction developer growth CLI for Saw Eh Doh Wah.
|
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
|
+
Install the published package globally so the `devgrowth` command is
|
|
8
|
+
available anywhere:
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npm install -g devgrowth
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
### Developing locally
|
|
15
|
+
|
|
16
|
+
If you're working from a clone of this repo instead of the published
|
|
17
|
+
package, use `npm link` to symlink your local checkout into the global npm
|
|
18
|
+
bin:
|
|
19
|
+
|
|
7
20
|
```bash
|
|
8
21
|
npm install
|
|
9
22
|
npm link
|
|
@@ -86,5 +99,13 @@ one-line banner, so the layout never wraps.
|
|
|
86
99
|
|
|
87
100
|
## Troubleshooting
|
|
88
101
|
|
|
89
|
-
- If `devgrowth` command is not found
|
|
90
|
-
|
|
102
|
+
- If `devgrowth` command is not found, you likely installed without `-g`
|
|
103
|
+
(`npm install devgrowth` puts it in a local `node_modules` folder, not on
|
|
104
|
+
your PATH). Run `npm install -g devgrowth` instead. If you're developing
|
|
105
|
+
from a clone, run `npm link` from the project directory.
|
|
106
|
+
- Still not found after a global install? The npm global bin folder may not
|
|
107
|
+
be on your PATH. Run `npm config get prefix` to find it (on Windows,
|
|
108
|
+
typically `%AppData%\npm`), confirm that folder is on PATH, then open a
|
|
109
|
+
new terminal.
|
|
110
|
+
- Windows install script requires the CLI to be in PATH. Ensure it has been
|
|
111
|
+
installed globally (or linked) first.
|