grim/local-pipelines

Update the readme to have people install from pypi

2016-07-22, Gary Kramlich
ad574fde605d
Parents ea6abc98e557
Children 19f723eff865
Update the readme to have people install from pypi
1 files changed, 18 insertions(+), 4 deletions(-)
  • +18 -4
    README.md
    • --- a/README.md Fri Jul 22 20:34:58 2016 -0500
    +++ b/README.md Fri Jul 22 23:48:08 2016 -0500
    @@ -5,15 +5,29 @@
    This supports mercurial and git.
    -## Running
    +## Installing
    -Packaging doesn't exist yet, but you can clone this repo and run it via
    +You can easily install it with a simple
    ```
    -python -m pipelines -f /path/to/project/bitbucket-pipelines.yml
    +pip install -U --user local-pipelines
    ```
    -And it'll run through it.
    +Once that's done make sure ~/.local/bin is in your $PATH.
    +
    +## Running
    +
    +You can run your your bitbucket-pipelines.yml from the working directory via:
    +
    +```
    +pipelines
    +```
    +
    +If you want to run it from another directory you can use
    +
    +```
    +pipelines -f /path/to/bitbucket-pipelines.yml
    +```
    ## TODO