diff --git a/README.md b/README.md index b9f45a41d..8ede8f1db 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,21 @@ # oref0 -Javascript plugins for openaps +Algorithm for OpenAPS implementations. To get started with OpenAPS, see the [OpenAPS documentation](http://openaps.readthedocs.org/en/latest/) -Master code coverage: [![Coverage Status](https://coveralls.io/repos/github/openaps/oref0/badge.svg?branch=master)](https://coveralls.io/github/openaps/oref0?branch=master) - -Dev code coverage: [![Coverage Status](https://coveralls.io/repos/github/openaps/oref0/badge.svg?branch=dev)](https://coveralls.io/github/openaps/oref0?branch=dev) - -## Installing +## Installing oref0 Install tools globally: `npm run global-install` -## Usage +## Usage of oref0 ### `oref0` -The open reference implementation of the reference design. + +
+ The open reference implementation of the reference design. (click to expand for more usage details) +
+ ``` Usage: oref0 @@ -85,9 +85,6 @@ These can be defined in crontab, or in a simple file, eg API_SECRET="..." NIGHTSCOUT_HOST=localhost:1337 ns-upload-entries ``` -## Contributing - -See the [CONTRIBUTING document](CONTRIBUTING.md) ### Get the source ``` @@ -115,6 +112,11 @@ git push origin -u wip/my-enhancement-fix-or-proposal ``` Then target our `dev` branch for a pull request/peer review. +
+ +## Contributing + +See the [CONTRIBUTING document](CONTRIBUTING.md). PRs welcome! ## openaps @@ -140,4 +142,6 @@ mindset to learn what are essentially "building blocks" to implement an OpenAPS instance. This is not a "set and forget" system; it requires diligent and consistent testing and monitoring to ensure each piece of the system is monitoring, predicting, and performing as desired. The -performance and quality of your system lies solely with you. +performance and quality of your system lies solely with you. + +Read the [OpenAPS documentation](http://openaps.readthedocs.io/en/latest/) for more details.