@ribershamoelias/forge 1.0.1 → 1.0.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 +24 -4
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -24,6 +24,7 @@
24
24
  <img src="https://img.shields.io/badge/TypeScript-5.x-3178c6?style=flat-square" />
25
25
  <img src="https://img.shields.io/badge/Node.js-18%2B-339933?style=flat-square" />
26
26
  <img src="https://img.shields.io/badge/Status-Active-22c55e?style=flat-square" />
27
+ <a href="https://www.npmjs.com/package/@ribershamoelias/forge"><img src="https://img.shields.io/npm/v/@ribershamoelias/forge?color=cb3837&label=npm&style=flat-square" /></a>
27
28
  </p>
28
29
 
29
30
  <!-- Command Box -->
@@ -31,6 +32,11 @@
31
32
  <code>npx forge setup</code>
32
33
  </pre>
33
34
 
35
+ <!-- NPM Package -->
36
+ <p>
37
+ <a href="https://www.npmjs.com/package/@ribershamoelias/forge">@ribershamoelias/forge on npm</a>
38
+ </p>
39
+
34
40
  </div>
35
41
 
36
42
  ---
@@ -90,16 +96,30 @@ $ forge profile apply web-dev
90
96
 
91
97
  ---
92
98
 
99
+
93
100
  ## ⚡ Quick Start
94
101
 
102
+ ### Install via npm (recommended)
103
+
104
+ ```sh
105
+ npm install -g @ribershamoelias/forge
106
+ ```
107
+
108
+ ### Or use npx (no install required)
109
+
110
+ ```sh
111
+ npx @ribershamoelias/forge setup
112
+ ```
113
+
114
+ ### Or use the legacy install script (macOS & Linux)
115
+
95
116
  ```sh
96
- # 1. Install (macOS & Linux)
97
117
  curl -fsSL https://forge.sh/install | sh
118
+ ```
98
119
 
99
- # 2. Setup your environment
100
- forge setup
120
+ ### Apply a profile
101
121
 
102
- # 3. Apply a profile
122
+ ```sh
103
123
  forge profile apply web-dev
104
124
  ```
105
125
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ribershamoelias/forge",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "description": "The standard way developers set up their machines.",
5
5
  "main": "dist/cli.js",
6
6
  "bin": {
@@ -12,7 +12,7 @@
12
12
  "dev": "ts-node ./bin/forge.ts"
13
13
  },
14
14
  "author": "",
15
- "license": "MIT",
15
+ "license": "LOEL",
16
16
  "type": "commonjs",
17
17
  "dependencies": {
18
18
  "@types/fs-extra": "^11.0.4",