Merge 55bab02 into b939ad4

Pipfile

@@ -9,6 +9,8 @@ name = "pypi"
 [dev-packages]
 "flake8" = "*"
 mypy = "*"
+sphinx = "*"
+"m2r" = "*"
 
 [requires]
 python_version = "3.7"

README.md

@@ -6,5 +6,32 @@
 
 A python implementation/abstraction of the [Ness D8x / D16x Serial Interface ASCII protocol](http://www.nesscorporation.com/Software/Ness_D8-D16_ASCII_protocol.pdf)
 
-Currently a work-in-progress. Please check back soon or raise a pull request. This library is being developed with the intention of integrating it with [Home Assistant](https://www.home-assistant.io/).
+## Installing nessclient
 
+`nessclient` is available directly from pip:
+
+```sh
+pip install nessclient
+```
+
+## CLI
+
+This package includes a CLI which uses the library to interface with the Ness Serial Interface. You can read more in [the docs]()
+
+To use the CLI you must install it's dependencies by installing it with extras for `cli`: 
+
+```
+pip install nessclient[cli]
+ness-cli --help
+``` 
+
+## API Documentation
+You can find the full API documentation [here]()
+
+## Examples
+
+Please see [Examples]() section in the docs for examples. These same examples can be found as source in the [examples/](examples) directory. 
+
+## Developing
+
+Please see [Developing]() section in the docs for development environment setup information.

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/api.md

@@ -0,0 +1,23 @@
+# API
+
+## nessclient Core
+
+.. automodule:: nessclient
+    :members:
+    :undoc-members:
+    :exclude-members: BaseEvent
+
+## nessclient.event
+
+.. automodule:: nessclient.event
+    :members:
+    :undoc-members:
+
+
+## nessclient.connection
+
+.. automodule:: nessclient.connection
+    :members:
+    :undoc-members:
+
+.

docs/cli.md

@@ -0,0 +1,10 @@
+# CLI
+
+This package includes a CLI which uses the library to interface with the Ness Serial Interface.
+
+To use the CLI you must install it's dependencies by installing it with extras for `cli`:
+
+```
+pip install nessclient[cli]
+ness-cli --help
+```