@nakedev/go-scaffold 0.1.1 → 0.1.2

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.
Files changed (2) hide show
  1. package/README.md +13 -9
  2. package/package.json +5 -1
package/README.md CHANGED
@@ -12,22 +12,26 @@ same shape as the last one.
12
12
  ## Install
13
13
 
14
14
  ```bash
15
- pnpm install
16
- pnpm run build
15
+ npm install -g @nakedev/go-scaffold
17
16
  ```
18
17
 
19
- `npm link` / `pnpm link --global` may not put the binary on your `PATH`
20
- depending on your machine's npm/pnpm global-bin config — rather than fight
21
- that, run the CLI directly, or add a shell alias once:
18
+ Or run it without installing:
19
+
20
+ ```bash
21
+ npx @nakedev/go-scaffold create my-api
22
+ ```
23
+
24
+ Working on the CLI itself (not just using it)? Clone the repo, then:
22
25
 
23
26
  ```bash
27
+ pnpm install
28
+ pnpm run build
24
29
  node bin/go-scaffold.js create my-api --defaults
25
- # or: alias go-scaffold="node $(pwd)/bin/go-scaffold.js"
26
30
  ```
27
31
 
28
- The rest of this README uses the bare `go-scaffold ...` form for brevity
29
- substitute the `node bin/go-scaffold.js ...` form or your alias if you
30
- haven't linked it.
32
+ `npm link` / `pnpm link --global` may not put the binary on your `PATH`
33
+ depending on your machine's npm/pnpm global-bin config running
34
+ `node bin/go-scaffold.js ...` directly sidesteps that.
31
35
 
32
36
  ## Quick start
33
37
 
package/package.json CHANGED
@@ -1,7 +1,11 @@
1
1
  {
2
2
  "name": "@nakedev/go-scaffold",
3
- "version": "0.1.1",
3
+ "version": "0.1.2",
4
4
  "description": "Scaffold Gin + GORM + Postgres Go backend projects with a consistent domain-module standard",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "git+https://github.com/NakePranob/go-scaffold.git"
8
+ },
5
9
  "bin": {
6
10
  "go-scaffold": "./bin/go-scaffold.js"
7
11
  },