Update README.md

eventbrite · Dec 1, 2016 · de8d235 · de8d235
1 parent d5a724e
commit de8d235
Showing 1 changed file with 15 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -3,9 +3,23 @@
 ## Summary
 A generic annotation decorator for Python tests run under `nosetests` that outputs namespaced mappings to `.csv` files
 
+## Usage
+Annotate a test case with a TestRail test case id:
+```
+import unittest
+from nose_annotator.plugin import nose_annotator
+
+class TestSampleClass(unittest.TestCase):
+
+    @nose_annotator('testrail', '2729')
+    def test_numbers(self):
+        assert 1 == 1
+```
+
 ## Quick Start
 See `examples/test_sample.py` file for annotation examples.
-Follow the instructions below to see plugin in action
+
+Follow the instructions below to see plugin in action.
 ```
 $ git clone https://github.com/rv-kip/nose-annotator.git
 $ cd nose-annotator