Documentation: Extend ReadMe

sanssecours · Oct 30, 2016 · 850b3f5 · 850b3f5
1 parent 7d73117
commit 850b3f5
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 1 deletion.
diff --git a/Documentation/Folding.png b/Documentation/Folding.png
diff --git a/Documentation/Symbol List.png b/Documentation/Symbol List.png
diff --git a/Documentation/Syntax Highlighting - Correct Code.png b/Documentation/Syntax Highlighting - Correct Code.png
diff --git a/Documentation/Syntax Highlighting - Incorrect Code.png b/Documentation/Syntax Highlighting - Incorrect Code.png
diff --git a/ReadMe.md b/ReadMe.md
@@ -1,10 +1,36 @@
 # ABNF Bundle
 
-This [TextMate][] bundle adds support for [Augmented Backus–Naur Form][] a meta-language used to write  context free grammars.
+This [TextMate][] bundle adds support for [Augmented Backus–Naur Form][], a meta-language used to write  context free grammars.
 
 [TextMate]: https://github.com/textmate/textmate
 [Augmented Backus–Naur Form]: https://en.wikipedia.org/wiki/Augmented_Backus–Naur_Form
 
+# Features
+
+## Syntax Highlighting
+
+The screenshot below shows syntax highlighting for correct ABNF code using the [Rainbow Dash][] theme .
+
+[Rainbow Dash]: http://github.com/sanssecours/Rainbow-Dash.tmbundle
+
+![Syntax Highlighting   Correct Code](Documentation/Syntax Highlighting - Correct Code.png)
+
+The included ABNF grammar also catches common mistakes:
+
+![Syntax Highlighting   Incorrect Code](Documentation/Syntax Highlighting - Incorrect Code.png)
+
+## Symbol List
+
+To quickly jump to rule definitions use <kbd>⌘</kbd>+<kbd>⇧</kbd>+<kbd>T</kbd>:
+
+![Symbol List](Documentation/Symbol List.png)
+
+## Code Folding
+
+Use code folding to temporarily hide the content of long rules:
+
+![Folding](Documentation/Folding.png)
+
 # Installation
 
 ## Manual