added installation and usage instructions in README.rst as well, adde…

…d date to latest documented release in HISTORY.rst
zalando · Oct 18, 2016 · 4abd2a7 · 4abd2a7
1 parent a1ae80a
commit 4abd2a7
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 2 deletions.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -1,8 +1,8 @@
 History
 =======
 
-0.2.5
------
+0.2.5 (2016-05-30)
+------------------
 
 * Inclusion of cli in install
 * many other minor changes since open-sourcing...

diff --git a/README.rst b/README.rst
@@ -44,6 +44,36 @@ Major statistical functionalities include:
 - **subgroup analysis**
 - **trend**
 
+
+Installation
+============
+
+To install ExpAn, run this command in your terminal:
+
+.. code-block:: console
+
+    $ pip install expan
+
+
+Usage
+=====
+
+To use ExpAn in a project::
+
+    import expan
+
+Some mock-up data:
+
+::
+
+    from expan.core.experiment import Experiment
+    from tests.tests_core.test_data import generate_random_data
+
+    exp = Experiment('B', *generate_random_data())
+    exp.delta()
+
+
+
 Documentation
 =============