git-workspace-bare 0.1.0 → 0.1.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.
Files changed (2) hide show
  1. package/README.md +10 -10
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -4,19 +4,12 @@ Manage Git worktrees as development workspaces.
4
4
 
5
5
  The CLI can clone GitHub repositories, create branch worktrees, list registered checkouts, and unregister them.
6
6
 
7
- ## Local setup
7
+ ## Installation
8
8
 
9
- The CLI runs on [Bare](https://github.com/holepunchto/bare). Install Bare using npm:
9
+ The CLI runs on [Bare](https://github.com/holepunchto/bare). Install both globally using npm:
10
10
 
11
11
  ```sh
12
- npm install -g bare
13
- ```
14
-
15
- Then run from the repository directory:
16
-
17
- ```sh
18
- npm install
19
- npm link
12
+ npm install -g bare git-workspace-bare
20
13
  ```
21
14
 
22
15
  This makes the `git-workspace` command available in your shell. Git also discovers it on your `PATH`, so you can run it as `git workspace`. Bare must be on your `PATH`; Node.js and npm are used for package installation and development tooling.
@@ -229,6 +222,13 @@ hint: remove the linked worktrees first
229
222
 
230
223
  ## Development
231
224
 
225
+ With Bare installed, run from the repository directory to install dependencies and link the local CLI:
226
+
227
+ ```sh
228
+ npm install
229
+ npm link
230
+ ```
231
+
232
232
  Run the Brittle integration tests on Bare (Git must be installed):
233
233
 
234
234
  ```sh
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "git-workspace-bare",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Manage Git worktrees as development workspaces",
5
5
  "type": "module",
6
6
  "bin": {