diff --git a/README.md b/README.md index f4b30ce..5a64381 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,17 @@ # saveable-objects A python package for checkpointing, saving, and loading objects. +## Installation + +The python package can be installed with pip as follows: +```bash +pip install saveable-objects +``` + +## Documentation + +Documentation including worked examples can be found at: + ## Source Code Source code can be found at: [https://github.com/Christopher-K-Long/saveable-objects](https://github.com/Christopher-K-Long/saveable-objects). @@ -8,5 +19,5 @@ Source code can be found at: [https://github.com/Christopher-K-Long/saveable-obj ## Version and Changes -The current version is [`0.0.0`](ChangeLog#release-100). Please see the [Change Log](ChangeLog.md) for more +The current version is [`1.0.0`](ChangeLog.md#release-100). Please see the [Change Log](ChangeLog.md) for more details. \ No newline at end of file