holm/httpie-cli
1
1
Fork 0
forked from extern/httpie-cli
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: improve documentation for installation of unstable version (#1490)

Browse Source 
* 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 <jakub@roztocil.co>
This commit is contained in:
Sid 2023-05-09 14:53:29 +05:30 committed by GitHub
parent 47e9b99ba1
commit 1ae4152e1e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/README.md
View File

@ -250,36 +250,39 @@ $ pkg upgrade www/py-httpie
### Unstable version
You can also install the latest unreleased development version directly from the `master` branch on GitHub.
It is a work-in-progress of a future stable release so the experience might be not as smooth.
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.
You can install it on Linux, macOS, Windows, or FreeBSD with `pip`:
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`.
```bash
$ python -m pip install --upgrade https://github.com/httpie/httpie/archive/master.tar.gz
```
Or on macOS, and Linux, with Homebrew:
There are other ways to install the development version of HTTPie on macOS and Linux.
You can install it using Homebrew by running the following commands:
```bash
$ brew uninstall --force httpie
$ brew install --HEAD httpie
```
And even on macOS, and Linux, with Snapcraft:
You can install it using Snapcraft by running the following commands:
```bash
$ snap remove httpie
$ snap install httpie --edge
```
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:
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`.
```bash
$ http --version
# 3.X.X.dev0
```
Note that on your machine, the version name will have the `.dev0` suffix.
## Usage
Hello World: