Skip to content

Commit

Permalink
docs(readme): better install & contrib. instruct.
Browse files Browse the repository at this point in the history
  • Loading branch information
MicaelJarniac committed Mar 2, 2021
1 parent 3718cbd commit 05ca34b
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,19 @@ Simple URL builder

## Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install BuildURL.
### pip
[*buildurl*](https://pypi.org/project/buildurl) is available on [pip](https://pip.pypa.io/en/stable/):

```bash
pip install buildurl
```

### GitHub
You can also install the latest version of the code directly from GitHub:
```bash
pip install git+git://github.com/MicaelJarniac/BuildURL
```

## Usage


Expand Down Expand Up @@ -113,5 +120,9 @@ Pull requests are welcome. For major changes, please open an issue first to disc

Please make sure to update tests as appropriate.

More details can be found in [CONTRIBUTING](CONTRIBUTING.md).

## Contributors ✨

## License
[MIT](https://choosealicense.com/licenses/mit/)
[MIT](LICENSE)

0 comments on commit 05ca34b

Please sign in to comment.