Skip to content

Commit

Permalink
Adding links to documentation, and creating drop-down for readability
Browse files Browse the repository at this point in the history
  • Loading branch information
danamlewis authored Jun 11, 2018
1 parent e30a7eb commit f933a82
Showing 1 changed file with 16 additions and 12 deletions.
28 changes: 16 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

<details>
<summary>The open reference implementation of the reference design. (click to expand for more usage details)</summary>
<br>

```
Usage:
oref0 <cmd>
Expand Down Expand Up @@ -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 <input> <output>
```

## Contributing

See the [CONTRIBUTING document](CONTRIBUTING.md)
### Get the source

```
Expand Down Expand Up @@ -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.

</details>

## Contributing

See the [CONTRIBUTING document](CONTRIBUTING.md). PRs welcome!

## openaps

Expand All @@ -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.

0 comments on commit f933a82

Please sign in to comment.