gflows 0.1.5 → 0.1.8

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 +39 -13
  2. package/package.json +2 -1
package/README.md CHANGED
@@ -40,29 +40,55 @@ git --version
40
40
 
41
41
  ## Installation
42
42
 
43
- **From the repository (development or link):**
43
+ **As a dev dependency (recommended):**
44
+
45
+ **npm**
44
46
 
45
47
  ```bash
46
- git clone https://github.com/alialnaghmoush/gflows.git
47
- cd gflows
48
- bun install
49
- bun link # global `gflows` (or: npm link)
48
+ npm install --save-dev gflows
50
49
  ```
51
50
 
52
- **Run without installing** (from repo root):
51
+ **Bun**
53
52
 
54
53
  ```bash
55
- bun run gflows -- <command> ...
56
- # or
57
- bun run src/cli.ts -- <command> ...
54
+ bun add --dev gflows
58
55
  ```
59
56
 
60
- **After linking**, use `gflows` from any Git repository:
57
+ **JSR (npm / npx)**
61
58
 
62
59
  ```bash
63
- cd /path/to/your/repo
64
- gflows init
65
- gflows start feature my-feature
60
+ npx jsr add --dev @alialnaghmoush/gflows
61
+ ```
62
+
63
+ **JSR (Bun / bunx)**
64
+
65
+ ```bash
66
+ bunx jsr add --dev @alialnaghmoush/gflows
67
+ ```
68
+
69
+ **JSR (Deno)**
70
+
71
+ ```bash
72
+ deno add --dev jsr:@alialnaghmoush/gflows
73
+ ```
74
+
75
+ Available on:
76
+
77
+ - [npm: gflows](https://www.npmjs.com/package/gflows)
78
+ - [JSR: @alialnaghmoush/gflows](https://jsr.io/@alialnaghmoush/gflows)
79
+
80
+ **Global install (optional):**
81
+
82
+ **npm**
83
+
84
+ ```bash
85
+ npm install --global gflows
86
+ ```
87
+
88
+ **Bun**
89
+
90
+ ```bash
91
+ bun add --global gflows
66
92
  ```
67
93
 
68
94
  ---
package/package.json CHANGED
@@ -1,7 +1,8 @@
1
1
  {
2
2
  "name": "gflows",
3
- "version": "0.1.5",
3
+ "version": "0.1.8",
4
4
  "description": "A lightweight CLI for consistent Git branching workflows (main + dev, feature/bugfix/chore/release/hotfix).",
5
+ "license": "MIT",
5
6
  "type": "module",
6
7
  "module": "src/index.ts",
7
8
  "bin": {