]> code.delx.au - gnu-emacs-elpa/commitdiff
Add readme.
authorJackson Ray Hamilton <jackson@jacksonrayhamilton.com>
Thu, 20 Nov 2014 03:01:41 +0000 (19:01 -0800)
committerJackson Ray Hamilton <jackson@jacksonrayhamilton.com>
Thu, 20 Nov 2014 03:01:41 +0000 (19:01 -0800)
README.md [new file with mode: 0644]
screenshot.png [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
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 (file)
index 0000000..0d9356d
Binary files /dev/null and b/screenshot.png differ