Skip to content

Commit 1ae4152

Browse files
hugo-sidjkbrzt
andauthored
docs: improve documentation for installation of unstable version (#1490)
* docs: improve documentation for installation of unstable version I am trying to rephrase the instructions to make it clear, concise and beginner friendly. Summary of changes: * rephrased the instructions to install unstable version of HTTPie * rephrased the instructions to verify the installation * fix(docs): remove trailing spaces * docs: fix 'pip' formatting Enclosed 'pip' with backticks to display it as inline code * docs: better description for pip installation (unstable version) * Update docs/README.md --------- Co-authored-by: Jakub Roztocil <[email protected]>
1 parent 47e9b99 commit 1ae4152

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

docs/README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -250,36 +250,39 @@ $ pkg upgrade www/py-httpie
250250

251251
### Unstable version
252252

253-
You can also install the latest unreleased development version directly from the `master` branch on GitHub.
254-
It is a work-in-progress of a future stable release so the experience might be not as smooth.
253+
If you want to try out the latest version of HTTPie that hasn't been officially released yet, you can install the development or unstable version directly from the master branch on GitHub. However, keep in mind that the development version is a work in progress and may not be as reliable as the stable version.
255254

256-
You can install it on Linux, macOS, Windows, or FreeBSD with `pip`:
255+
You can use the following command to install the development version of HTTPie on Linux, macOS, Windows, or FreeBSD operating systems. With this command, the code present in the `master` branch is downloaded and installed using `pip`.
257256

258257
```bash
259258
$ python -m pip install --upgrade https://github.com/httpie/httpie/archive/master.tar.gz
260259
```
261260

262-
Or on macOS, and Linux, with Homebrew:
261+
There are other ways to install the development version of HTTPie on macOS and Linux.
262+
263+
You can install it using Homebrew by running the following commands:
263264

264265
```bash
265266
$ brew uninstall --force httpie
266267
$ brew install --HEAD httpie
267268
```
268269

269-
And even on macOS, and Linux, with Snapcraft:
270+
You can install it using Snapcraft by running the following commands:
270271

271272
```bash
272273
$ snap remove httpie
273274
$ snap install httpie --edge
274275
```
275276

276-
Verify that now you have the [current development version identifier](https://github.com/httpie/httpie/blob/master/httpie/__init__.py#L6) with the `.dev0` suffix, for example:
277+
To verify the installation, you can compare the [version identifier on GitHub](https://github.com/httpie/httpie/blob/master/httpie/__init__.py#L6) with the one available on your machine. You can check the version of HTTPie on your machine by using the command `http --version`.
277278

278279
```bash
279280
$ http --version
280281
# 3.X.X.dev0
281282
```
282283

284+
Note that on your machine, the version name will have the `.dev0` suffix.
285+
283286
## Usage
284287

285288
Hello World:

0 commit comments

Comments
 (0)