Skip to content

Commit 97c19c3

Browse files
authored
[devbox] Update Readme based on community feedback (#2635)
+ Show an example of `devbox.json` + Add a link to Github issues in the community section + Change version badge to skip pre-releases
1 parent 67f27ef commit 97c19c3

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Instant, easy, and predictable shells and containers
44

5-
[![Join Discord](https://img.shields.io/discord/903306922852245526?color=7389D8&label=discord&logo=discord&logoColor=ffffff)](https://discord.gg/agbskCJXk2) ![License: Apache 2.0](https://img.shields.io/github/license/jetpack-io/devbox) [![version](https://img.shields.io/github/v/release/jetpack-io/devbox?color=green&include_prereleases&label=version&sort=semver)](https://github.com/jetpack-io/devbox/releases)
5+
[![Join Discord](https://img.shields.io/discord/903306922852245526?color=7389D8&label=discord&logo=discord&logoColor=ffffff)](https://discord.gg/agbskCJXk2) ![License: Apache 2.0](https://img.shields.io/github/license/jetpack-io/devbox) [![version](https://img.shields.io/github/v/release/jetpack-io/devbox?color=green&label=version&sort=semver)](https://github.com/jetpack-io/devbox/releases)
66

77
---
88

@@ -72,37 +72,46 @@ In this quickstart we’ll create a development shell with specific tools instal
7272
devbox init
7373
```
7474

75-
This creates `devbox.json`. You should commit this file.
75+
This creates a `devbox.json` file in the current directory. You should commit it to source control.
7676

7777
3. Add command-line tools from [Nix Packages](https://search.nixos.org/packages). For example, to add Python 3.10:
7878

7979
```bash
8080
devbox add python310
8181
```
82+
4. Your `devbox.json` file keeps track of the packages you've added, it should now look like this:
83+
84+
```json
85+
{
86+
"packages": [
87+
"python310"
88+
]
89+
}
90+
```
8291

83-
4. Start a new shell that has these tools installed:
92+
5. Start a new shell that has these tools installed:
8493

8594
```bash
8695
devbox shell
8796
```
8897

8998
You can tell you’re in a Devbox shell (and not your regular terminal) because the shell prompt and directory changed.
9099

91-
5. Use your favorite tools.
100+
6. Use your favorite tools.
92101

93102
In this example we installed Python 3.10, so let’s use it.
94103

95104
```bash
96105
python --version
97106
```
98107

99-
6. Your regular tools are also available including environment variables and config settings.
108+
7. Your regular tools are also available including environment variables and config settings.
100109

101110
```bash
102111
git config --get user.name
103112
```
104113

105-
7. To exit the Devbox shell and return to your regular shell:
114+
8. To exit the Devbox shell and return to your regular shell:
106115

107116
```bash
108117
exit
@@ -142,7 +151,8 @@ Want more languages? [Ask for a new Language](https://github.com/jetpack-io/devb
142151

143152
## Join our Developer Community
144153

145-
Ask questions, suggest ideas, and get help by [joining the `#devbox` channel](https://discord.gg/agbskCJXk2) in the Jetpack.io Discord Server.
154+
+ Chat with us by joining the [Jetpack.io Discord Server](https://discord.gg/agbskCJXk2) – we have a #devbox channel dedicated to this project.
155+
+ File bug reports and feature requests using [Github Issues](https://github.com/jetpack-io/devbox/issues)
146156

147157
## Related Work
148158

0 commit comments

Comments
 (0)