Skip to content

Commit 052a1f7

Browse files
committed
More docs
1 parent 0e1a0c9 commit 052a1f7

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ packages you need for different projects as you navigate in your shell.
99
echo 'eval "$(pkgx dev --shellcode)"' >> ~/.zshrc
1010
```
1111

12+
We support bashlike shells (adapt the rc file above). Fish support is welcome,
13+
but I don’t understand Fish so please PR!
14+
1215
> [!NOTE]
1316
>
1417
> `pkgx` is a required dependency.
@@ -20,20 +23,40 @@ echo 'eval "$(pkgx dev --shellcode)"' >> ~/.zshrc
2023
> [!TIP]
2124
> If you like, preview the shellcode: `pkgx dev --shellcode`.
2225
26+
> [!TIP]
27+
>
28+
> ### Try Before You `vi`
29+
>
30+
> Modifying your `shell.rc` can be… *intimidating*. If you just want to
31+
> temporarily try `dev` out before you `:wq`—we got you:
32+
>
33+
> ```sh
34+
> $ cd my-project
35+
> $ eval "$(pkgx dev)"
36+
> ```
37+
>
38+
> The devenv will only exist for the duration of your shell session.
39+
2340
## Usage
2441
2542
```sh
2643
$ cd my-project
44+
2745
my-project $ ls
2846
package.json
47+
2948
my-project $ dev
3049
+nodejs.org
50+
3151
my-project $ node --version
3252
v22.12.0
53+
3354
$ which node
3455
~/.pkgx/nodejs.org/v22.12.0/bin/node
56+
3557
$ cd ..
3658
-nodejs.org
59+
3760
$ node
3861
command not found: node
3962
```

0 commit comments

Comments
 (0)