README.md in checkpoint-1.0.3 vs README.md in checkpoint-1.1.0
- old
+ new
@@ -1,7 +1,8 @@
[![Build Status](https://travis-ci.org/mlibrary/checkpoint.svg?branch=master)](https://travis-ci.org/mlibrary/checkpoint?branch=master)
[![Coverage Status](https://coveralls.io/repos/github/mlibrary/checkpoint/badge.svg?branch=master)](https://coveralls.io/github/mlibrary/checkpoint?branch=master)
+[![Documentation Status](https://readthedocs.org/projects/checkpoint/badge/?version=latest)](https://checkpoint.readthedocs.io/en/latest/?badge=latest)
# Checkpoint
Checkpoint provides a model and infrastructure for policy-based authorization,
especially in Rails applications.
@@ -15,9 +16,14 @@
```
And then execute:
$ bundle
+
+## Documentation
+
+User documentation source is available in the `docs` directory, and in rendered format
+on [readthedocs](https://checkpoint.readthedocs.io/en/latest/).
## License
Checkpoint is licensed under the BSD-3-Clause license. See [LICENSE.md](LICENSE.md).