From de8d235e519844d63dffa07b8a09974dbce3a1c2 Mon Sep 17 00:00:00 2001
From: Kip Gebhardt <rv-kip@users.noreply.github.com>
Date: Thu, 1 Dec 2016 11:43:30 -0800
Subject: [PATCH] Update README.md

---
 README.md | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 930711f..de58cdb 100644
--- 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