aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTeddy Wing2015-08-01 19:08:52 -0400
committerTeddy Wing2015-08-01 19:08:52 -0400
commita01faacc571ae114ce7c599d3fd368e2d9b741bd (patch)
tree0fff734a36c8ae796e65903725fdcb281460b50f /README.md
parenteb38cdeebc31db8ca85d0303c5588e8c0a96b37c (diff)
downloadjira-whozits-a01faacc571ae114ce7c599d3fd368e2d9b741bd.tar.bz2
Add LICENSE & READMEv0.0.1
* MIT license * README: add description, usage information, installation notes, and license information
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..95a5c8a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+Jira Whozits
+============
+
+A Google Chrome browser extension that adds ids to team member headers on the
+scrum board.
+
+In a large team, this makes it faster to navigate to a team member's section of
+the board and stories, allowing you to jump directly to that section instead of
+having to scroll through the entire board to find it.
+
+
+## Usage
+Append the name of a team member to the URL removing any spaces:
+
+ https://some-company.atlassian.net/secure/RapidBoard.jspa?rapidView=5&selectedIssue=SC-1000#PhilpJFry
+
+
+## Installing
+Download the .crx file from the [releases][0] page. Drag and drop the file into
+the Chrome Extensions page.
+
+
+## License
+Licensed under the MIT License. See the included LICENSE file.
+
+[0]: https://github.com/teddywing/jira-whozits/releases