Skip to content

Commit

Permalink
Add instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
jmgate committed Nov 2, 2021
1 parent 759ce10 commit ee7d56d
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,21 @@ sl.log("Execute my first command in the shell.", "echo 'Hello World'")
For more detailed usage and API information, please see [our
documentation](http://shelllogger.internal.gitlab.pages/ShellLogger).

## Adding `ShellLogger` as a Requirement for your Package

If you'll be developing a package that will use `ShellLogger`, we recommend
adding this to your `requirements.txt` file
```
shelllogger @ git+https://internal.gitlab.server/ShellLogger/ShellLogger@master#egg=shelllogger
```

replacing `master` with whatever git reference you like, and then using `pip
install -r requirements.txt` to handle installing it.

Alternatively, if you're prevented from using the solution above, you can use
`snapshot.py` to snapshot a subset of this repository into your own. See the
`--help` text for details.

## Where to Get Help

If you're having trouble with `ShellLogger`, or just want to ask a question,
Expand Down

0 comments on commit ee7d56d

Please sign in to comment.