docs: add automatically created API documentation (#55)

* use jsdoc-to-markdown * create API documentation
connium · Oct 18, 2018 · 1557c4b · 1557c4b
1 parent 8766c6b
commit 1557c4b
Show file tree

Hide file tree

Showing 22 changed files with 2,446 additions and 10 deletions.
diff --git a/.npmignore b/.npmignore
@@ -3,6 +3,7 @@
 coverage/
 docs/
 examples/
+jsdoc2md/
 lib/test/
 src/
 test/

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 
 ## [Unreleased] (2018-??-??)
+### Added
+- **docs:** Add automatically created API documentation, closes [#16](https://github.com/connium/simple-odf/issues/16)
 
 ## [0.6.0] (2018-10-12)
 ### Added

diff --git a/README.md b/README.md
@@ -59,6 +59,12 @@ list.addItem("just write like you would do in a full-blown editor");
 document.saveFlat("/home/homer/My_first_document.fodf");
 ```
 
+## Documentation
+
+Learn more about the [OASIS Open Document Format](http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html).
+
+- [API reference](./docs/API.md)
+
 ## Contributing
 
 If you want to contribute to simple-odf, you are very welcome. Send issues and pull requests with your ideas.
@@ -96,4 +102,4 @@ If you want to contribute to simple-odf, you are very welcome. Send issues and p
 
 ### License
 
-By contributing to simple-odf, you agree that your contributions will be licensed under its MIT license.
+By contributing to simple-odf, you agree that your contributions will be licensed under its [MIT license](./LICENSE).