Skip to content

Commit

Permalink
More docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mxcl committed Jan 8, 2025
1 parent 0e1a0c9 commit 1d659d1
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ packages you need for different projects as you navigate in your shell.
echo 'eval "$(pkgx dev --shellcode)"' >> ~/.zshrc
```

We support bashlike shells (adapt the rc file above). Fish support is welcome,
but I don’t understand Fish so please PR!

> [!NOTE]
>
> `pkgx` is a required dependency.
Expand All @@ -20,6 +23,20 @@ echo 'eval "$(pkgx dev --shellcode)"' >> ~/.zshrc
> [!TIP]
> If you like, preview the shellcode: `pkgx dev --shellcode`.
> [!TIP]
>
> ### Try Before You `vi`
>
> Modifying your `shell.rc` can be… *intimidating*. If you just want to
> temporarily try `dev` out before you `:wq`—we got you:
>
> ```sh
> $ cd my-project
> $ eval "$(pkgx dev)"
> ```
>
> The devenv will only exist for the duration of your shell session.
## Usage
```sh
Expand Down

0 comments on commit 1d659d1

Please sign in to comment.