Updated to version 1.0.1

apache · Jul 29, 2016 · 470ce34 · 470ce34
1 parent 3b4dc24
commit 470ce34
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 12 deletions.
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -1,5 +1,6 @@
-UserAle.pyqt5 is written and maintained by Michelle Beard and 
-various contributors:
+.. _authors:
+
+UserAle.pyqt5 is written and maintained by Draper and various contributors:
 
 Development Lead
 ````````````````
@@ -12,5 +13,4 @@ Additional Staff
 - Laura Mariano <lmariano@draper.com>
 - Dr. Joshua Poore <jpoore@draper.com>
 - Clay Gimenez <cgimenez@draper.com>
-- Steven York <syork@draper.com>
 - Hugh Enxing <henxing@draper.com>
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,4 +1,23 @@
-Version 1.0.0
--------------
+.. _changelog:
 
-    - Initial commit.
+1.0.1 (2016-07-29)
+------------------
+
+* All logs will be stored to file called userale.log (configurable).
+* Users can specify which events to capture by passing in a list of event keys when instantiating UserAle.
+* These are the events UserAle is tracking:
+
+	* ``mouseup``
+	* ``mousedown``
+	* ``mouseover``
+	* ``keypress`` (optional)
+	* ``keydown`` (optional)
+	* ``dragstart``
+	* ``dragleave``
+	* ``dragmove``
+	* ``dragdrop``
+
+1.0.0 (2016-06-24)
+------------------
+
+Initial release.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -1,3 +1,5 @@
+.. _contributing:
+
 Contributing to UserAle.pyqt5
 -----------------------------
 
@@ -8,9 +10,9 @@ procedures are necessary to allow us to allocate resources for reviewing and
 testing your contribution, as well as communicate effectively with you during
 the review process.
 
-1) Create an issue in our JIRA
+1) Create an issue in GitHub
 
-    All changes to UserAle must have corresponding issues in JIRA so the
+    All changes to UserAle must have corresponding issues in GitHub so the
     change can be properly tracked:
 
         https://github.com/draperlaboratory/userale.pyqt5/issues

diff --git a/README.rst b/README.rst
@@ -3,6 +3,6 @@ UserAle
 
 UserAle.pyqt5 is one of the Software As A Sensor™ products. The goal of Software As A Sensor™ is to develop understanding 
 of your users through their interactions with your software product. You can then apply that understanding to improve your 
-product's design and funtionality. UserAle.pyqt5 provides an easy way to generate highly detailed log streams from an PyQT5 application.
+product's design and functionality. UserAle.pyqt5 provides an easy way to generate highly detailed log streams from any PyQt5 application.
 
-UserAle.pyqt5 is developed at Draper and released free and open source through the Apache v2.0 license. Bug reports and contributions are welcome through Github.
+UserAle.pyqt5 is developed at Draper and released free and open source through the Apache v2.0 license. Bug reports and contributions are welcome through GitHub.
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -96,7 +96,7 @@ To build UserAle's documentation, create a directory at the root level of ``/use
 
 ::
 
-	$ mkdir userale.pyqt5-docs & cd userale.pyqt5/docs
+	$ mkdir userale.pyqt5-docs & cd userale.pyqt5-docs
 
 Execute build command:
 

diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst
@@ -54,3 +54,11 @@ Simply instantiate UserAle and install it as an event filter in your application
 	ale = Ale (output="mouse.log", user="testUser", version="0.0.1")
 	# install globally
 	app.installEventFilter (ale)
+
+
+Instrumenting Your Application Manually with UserAle
+----------------------------------------------------
+
+.. todo::
+
+	Write guidelines for instrumenting specific PyQt5 Widgets with UserAle.
diff --git a/userale/version.py b/userale/version.py
@@ -18,4 +18,4 @@
 and parsed by ``setup.py``.
 """
 
-__version__ = "1.0.0"
+__version__ = "1.0.1"