aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 15 insertions, 3 deletions
diff --git a/README.md b/README.md
index 9b0d1b1..1c368c6 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,18 @@
-README
-======
+ScrumDo Trellic
+===============
-# Resources
+ScrumDo Trellic is a Google Chrome extension for the [ScrumDo](http://www.scrumdo.com) scrum board. It provides keyboard shortcuts similar to those found in [Trello](https://trello.com) to speed up interaction with the board.
+
+Currently the project is buggy and incomplete, and ScrumDo has updated the design of their board since this was written.
+
+To install the extension, open the Extensions window in Chrome and click 'Load unpacked extension…'. In the file browser select the directory of this project.
+
+
+# Development Notes
+## Resources
- [KeyCode finder](http://jsfiddle.net/vWx8V/)
- [Keyboard shortcut library](http://craig.is/killing/mice)
+
+
+# License
+ScrumDo Trellic is licensed under the MIT License. See the included LICENSE file.