Commit ba626b3a by Sébastien Eustace

Update README

parent 87f605fb
...@@ -7,9 +7,6 @@ ensuring you have the right stack everywhere. ...@@ -7,9 +7,6 @@ ensuring you have the right stack everywhere.
![Poet Install](https://raw.githubusercontent.com/sdispater/poetry/master/assets/install.gif) ![Poet Install](https://raw.githubusercontent.com/sdispater/poetry/master/assets/install.gif)
The package is **highly experimental** at the moment so expect things to change and break.
However, if you feel adventurous feedback and pull requests are greatly appreciated.
Also, be aware that the features described here are the goal that this library is aiming Also, be aware that the features described here are the goal that this library is aiming
for and, as of now, not all of them are implemented (but most of them are). for and, as of now, not all of them are implemented (but most of them are).
The dependency management is done while the packaging and publishing are still at the beginning. The dependency management is done while the packaging and publishing are still at the beginning.
...@@ -19,10 +16,38 @@ Python project's with previous versions without any problem. ...@@ -19,10 +16,38 @@ Python project's with previous versions without any problem.
## Installation ## Installation
Poetry provides a custom installer that will install `poetry` isolated
from the rest of your system by vendorizing its dependencies. This is the
recommended way of installing `poetry`.
```bash
curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python
```
Alternatively, you can download the `get-poetry.py` file and execute it separately.
If you want to install prerelease versions, you can do so by passing `--preview` to `get-poetry.py`:
```bash ```bash
pip install poetry python get-poetry.py --preview
``` ```
Similarly, if you want to install a specific version, you can use `--version`:
```bash
python get-poetry.py --version 0.7.0
```
Using `pip` to install `poetry` is also possible.
```bash
pip install --user poetry
```
Be aware, however, that it will also install poetry's dependencies
which might cause conflicts.
### Enable tab completion for Bash, Fish, or Zsh ### Enable tab completion for Bash, Fish, or Zsh
`poetry` supports generating completion scripts for Bash, Fish, and Zsh. `poetry` supports generating completion scripts for Bash, Fish, and Zsh.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment