branch: master
commit cce215d1a900b648e258806e17cdcf7f4238db9e
Author: Jackson Ray Hamilton <jack...@jacksonrayhamilton.com>
Commit: Jackson Ray Hamilton <jack...@jacksonrayhamilton.com>
Add readme.
---
README.md | 23 +++++++++++++++++++++++
screenshot.png | Bin 0 -> 41693 bytes
2 files changed, 23 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..baf28f1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Context Coloring
+
+<p align="center">
+ <img alt="Screenshot of JavaScript code highlighted by context."
src="screenshots.png" title="Screenshot">
+</p>
+
+Highlights JavaScript code according to function context. Code in the global
+scope is white, code in functions within the global scope is yellow, code
within
+such functions is green, etc.
+
+## Usage
+
+- [Install Node.js 0.10 (or higher).][node]
+- Put `context-coloring.el` on your [load path][].
+- In your `~/.emacs`:
+
+```lisp
+(require 'context-coloring)
+(add-hook 'js-mode-hook 'context-coloring-mode)
+```
+
+[node]: http://nodejs.org/download/)
+[load path]:
https://www.gnu.org/software/emacs/manual/html_node/emacs/Lisp-Libraries.html
diff --git a/screenshot.png b/screenshot.png
new file mode 100644
index 0000000..0d9356d
Binary files /dev/null and b/screenshot.png differ
