aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst38
1 files changed, 38 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..a31a220
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,38 @@
+pyee
+====
+
+.. image:: https://travis-ci.org/jfhbrook/pyee.png
+ :target: https://travis-ci.org/jfhbrook/pyee
+.. image:: https://readthedocs.org/projects/pyee/badge/?version=latest
+ :target: https://pyee.readthedocs.io
+
+pyee supplies a ``EventEmitter`` object that is similar to the
+``EventEmitter`` class from Node.js. It also supplies a number of subclasses
+with added support for async and threaded programming in python, such as
+async/await as seen in python 3.5+.
+
+Docs:
+-----
+
+Autogenerated API docs, including basic installation directions and examples,
+can be found at https://pyee.readthedocs.io .
+
+Development:
+------------
+
+See ``DEVELOPMENT.rst``.
+
+Changelog:
+----------
+
+See ``CHANGELOG.rst``.
+
+Contributors:
+-------------
+
+See ``CONTRIBUTORS.rst``.
+
+License:
+--------
+
+MIT/X11, see ``LICENSE``.