diff --git a/README.md b/README.md index 883fceb..cd82a6f 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,24 @@ Python implementation of the _OSlg_ logger for the OpenStudio SDK. -- PyPi [oslg](https://pypi.org/project/oslg/) package -- original Ruby implementation/documentation [here](https://github.com/rd2/oslg) +- PyPi [package](https://pypi.org/project/oslg/) +- Ruby [gem](https://rubygems.org/gems/oslg) +- Ruby GitHub [repository](https://github.com/rd2/oslg) -_Disclaimer: alpha release_ +---- + +To download the _OSlg_ Python package: + +`pip install --upgrade oslg` + +---- + +To import the _OSlg_ module in a Python project: + +`from oslg import oslg` + +---- + +To run the _OSlg_ unit tests on a git clone of the repo: + +`python -m unittest`