@weezy20/zv 0.1.2 → 0.2.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 CHANGED
@@ -22,7 +22,35 @@ It also doubles as a project template starter, providing multiple variants of a
22
22
 
23
23
  ## Installation
24
24
 
25
- **Step 1:** Install the binary from crates.io or GitHub
25
+
26
+ **Quick install script (Recommended):**
27
+
28
+ Linux/macOS:
29
+ ```sh
30
+ curl --proto '=https' --tlsv1.2 -LsSf https://github.com/weezy20/zv/releases/latest/download/zv-installer.sh | sh
31
+ ```
32
+
33
+ Windows (PowerShell):
34
+ ```powershell
35
+ irm https://github.com/weezy20/zv/releases/latest/download/zv-installer.ps1 | iex
36
+ ```
37
+
38
+ **HomeBrew:**
39
+ ```sh
40
+ brew install weezy20/tap/zv
41
+ ```
42
+
43
+ **NPM:**
44
+ ```sh
45
+ npm install -g @weezy20/zv
46
+ ```
47
+
48
+ <details>
49
+ <summary><b>Cargo (crates.io or build from source)</b></summary>
50
+
51
+ **Step 1:** Install the binary from crates.io or build from source
52
+
53
+ Using `cargo install`:
26
54
  ```sh
27
55
  # From crates.io
28
56
  cargo install zv
@@ -31,34 +59,72 @@ cargo install zv
31
59
  cargo install --git https://github.com/weezy20/zv --locked
32
60
  ```
33
61
 
62
+ Or build from source (clone the repo first):
63
+ ```sh
64
+ # Build release binary (creates target/release/zv)
65
+ cargo build --release
66
+ ```
67
+
34
68
  **Step 2:** Preview setup changes (optional but recommended)
69
+
70
+ Using `cargo installed binary`:
35
71
  ```sh
36
72
  $HOME/.cargo/bin/zv setup --dry-run
37
73
  # OR shorthand:
38
74
  $HOME/.cargo/bin/zv setup -d
39
75
  ```
40
76
 
77
+ Or from source:
78
+ ```sh
79
+ cargo run --release -- setup --dry-run
80
+ # OR shorthand:
81
+ cargo run --release -- setup -d
82
+ ```
83
+
41
84
  **Step 3:** Run setup to install `zv` to `ZV_DIR/bin` and configure your shell
85
+
86
+ Using `cargo installed binary`:
42
87
  ```sh
43
88
  $HOME/.cargo/bin/zv setup
44
89
  ```
90
+
91
+ Or from source:
92
+ ```sh
93
+ cargo run --release -- setup
94
+ # or if you already have ZV_DIR/bin in path
95
+ cargo run --release -- sync
96
+ ```
97
+
45
98
  This self-installs `zv` to `ZV_DIR/bin` (default: `$HOME/.zv/bin` on Unix, `%USERPROFILE%\.zv\bin` on Windows) and adds it to your PATH.
46
99
 
47
- **Step 4:** Remove the cargo binary (optional cleanup)
100
+ **Step 4:** Remove the cargo binary (optional cleanup - only if you used `cargo install`)
48
101
  ```sh
49
102
  cargo uninstall zv
50
103
  ```
104
+
51
105
  From now on, use the `zv` installed in `ZV_DIR/bin`.
52
106
 
107
+ </details>
108
+
109
+ ---
110
+
111
+ > **Note:** Run `zv setup` after installation to self-install `zv` to `ZV_DIR/bin` (default: `$HOME/.zv/bin` on Unix, `%USERPROFILE%\.zv\bin` on Windows).
53
112
 
54
- ## Updating `zv`
113
+ ## Updating `zv`
55
114
 
56
- Repeat the installation steps above, or if you have the repo cloned:
115
+ If you have the repo cloned or are using cargo-installed binary:
57
116
  ```sh
58
- # Update from your local clone
117
+ # Builds new version and simultaneously runs setup to update the binary in ZV_DIR/bin
59
118
  cargo run --release -- setup
119
+ # Or you can also use sync
120
+ cargo run --release -- sync # Recommended
121
+ ```
122
+ If you have the quick install script you should have a `zv-update` command available:
123
+ ```sh
124
+ zv-update # fetches latest release and puts it in the default location for the method you used above
60
125
  ```
61
- This replaces your existing `ZV_DIR/bin/zv` installation.
126
+ If you used `zv-update` your `ZV_DIR/bin/zv` might still be on the older version. Just run `zv setup` or `zv sync` with the newer `bin` to update the binary in `ZV_DIR/bin`.
127
+ This replaces your existing `ZV_DIR/bin/zv` installation. This is not strictly necessary but recommeneded to keep your `ZV_DIR/bin/zv` binary up to date.
62
128
 
63
129
  ## Usage
64
130
 
@@ -23,7 +23,7 @@
23
23
  "hasInstallScript": true,
24
24
  "license": "MIT",
25
25
  "name": "@weezy20/zv",
26
- "version": "0.1.2"
26
+ "version": "0.2.1"
27
27
  },
28
28
  "node_modules/@isaacs/balanced-match": {
29
29
  "engines": {
@@ -896,5 +896,5 @@
896
896
  }
897
897
  },
898
898
  "requires": true,
899
- "version": "0.1.2"
899
+ "version": "0.2.1"
900
900
  }
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "artifactDownloadUrl": "https://github.com/weezy20/zv/releases/download/v0.1.2",
2
+ "artifactDownloadUrl": "https://github.com/weezy20/zv/releases/download/v0.2.1",
3
3
  "author": "Abhishek Shah <abhishekshah3@gmail.com>",
4
4
  "bin": {
5
5
  "zv": "run-zv.js"
@@ -91,7 +91,7 @@
91
91
  "zipExt": ".tar.xz"
92
92
  }
93
93
  },
94
- "version": "0.1.2",
94
+ "version": "0.2.1",
95
95
  "volta": {
96
96
  "node": "18.14.1",
97
97
  "npm": "9.5.0"