Skip to content

Commit df67365

Browse files
committed
README tweaking is my hobby
1 parent fd8de06 commit df67365

File tree

1 file changed

+31
-20
lines changed

1 file changed

+31
-20
lines changed

README.md

Lines changed: 31 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,19 @@ packages you need for different projects as you navigate in your shell.
99
pkgx dev integrate
1010
```
1111

12-
> [!NOTE]
12+
We support macOS & Linux, **Bash** & **Zsh**. PRs are very welcome for more
13+
shells.
14+
15+
> [!IMPORTANT]
1316
>
1417
> `pkgx` is a required dependency.
1518
>
1619
> ```sh
1720
> brew install pkgxdev/made/pkgx || sh <(curl https://pkgx.sh)
1821
> ```
1922
23+
> [!NOTE]
24+
>
2025
> `pkgx dev integrate` looks for and edits known `shell.rc` files adding one
2126
> line:
2227
>
@@ -29,26 +34,8 @@ pkgx dev integrate
2934
> ```sh
3035
> pkgx dev integrate --dry-run
3136
> ```
32-
33-
> We support **Bash** and **Zsh**. We would love to support more shells. PRs
34-
> very welcome.
35-
36-
> [!TIP]
37-
> If you like, preview the shellcode: `pkgx dev --shellcode`.
38-
39-
> [!TIP]
40-
>
41-
> ### Try Before You `vi`
42-
>
43-
> Modifying your `shell.rc` can be… _intimidating_. If you just want to
44-
> temporarily try `dev` out before you `:wq`—we got you:
45-
>
46-
> ```sh
47-
> $ cd my-project
48-
> $ eval "$(pkgx dev)"
49-
> ```
5037
>
51-
> The devenv will only exist for the duration of your shell session.
38+
> If you like, preview the shellcode: `pkgx dev --shellcode`.
5239
5340
## Usage
5441
@@ -60,6 +47,7 @@ package.json
6047
6148
my-project $ dev
6249
+nodejs.org
50+
# ^^ installs node to ~/.pkgx/nodejs.org/v22.12.0 if not already installed
6351
6452
my-project $ node --version
6553
v22.12.0
@@ -74,6 +62,20 @@ $ node
7462
command not found: node
7563
```
7664
65+
> [!TIP]
66+
>
67+
> ### Try Before You `vi`
68+
>
69+
> Modifying your `shell.rc` can be… _intimidating_. If you just want to
70+
> temporarily try `dev` out before you `:wq`—we got you:
71+
>
72+
> ```sh
73+
> $ cd my-project
74+
> $ eval "$(pkgx dev)"
75+
> ```
76+
>
77+
> The devenv will only exist for the duration of your shell session.
78+
7779
## How Packages are Determined
7880
7981
- We look at the files you have and figure out the packages you need.
@@ -126,6 +128,13 @@ You can add your own environment variables if you like:
126128
# MY_VAR: my-value
127129
```
128130
131+
> [!CAUTION]
132+
>
133+
> The assignment of these variables are run through the shell, so you can do
134+
> stuff like `$(pwd)` if you like. Obviously, be careful with that—we don’t
135+
> sanitize the input. We will accept a PR to escape this by default or something
136+
> ∵ we agree this is maybe a bit insane.
137+
129138
## GitHub Actions
130139
131140
```yaml
@@ -137,4 +146,6 @@ your terminal.
137146
138147
## Contributing
139148
149+
We use `deno`, so either install that or—you know—type `dev`.
150+
140151
Edit [./src/sniff.ts](src/sniff.ts) to add new dev types.

0 commit comments

Comments
 (0)