jade-highlighter - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

package.json

@@ -14,3 +14,3 @@ {
   },
-  "version": "1.0.2"
+  "version": "1.0.3"
 }

README.md

@@ -1,15 +0,24 @@
-# jade-brackets
+# Jade Tools
 
-This is the official jade plugin for [Brackets](http://brackets.io/).  This repository also houses the code mirror mode (in lib/mode.js) and the code for highlight-jade.
+This repository houses the source code that generates three different tools to help you program in jade:
 
-Brackets is the recommended editor for jade.
+ - jade-brackets: the official jade plugin for the brackets editor
+ - jade-highlight: a syntax highlighter for highlighting jade in node.js
+ - jade-code-mirror: a browserifyable npm library that adds jade support to code-mirror
 
+There's also the raw CodeMirror mode in /lib/mode.js
+
 [![Build Status](https://travis-ci.org/ForbesLindesay/jade-brackets.png?branch=master)](https://travis-ci.org/ForbesLindesay/jade-brackets)
 [![Dependency Status](https://gemnasium.com/ForbesLindesay/jade-brackets.png)](https://gemnasium.com/ForbesLindesay/jade-brackets)
 
-## highlight-jade
+## jade-brackets
 
+This is the official jade plugin for [Brackets](http://brackets.io/).  Brackets is the recommended editor for jade.
+
+
+## jade-highlight
+
 A simple syntax highlighter for jade.
 
-[![NPM version](https://badge.fury.io/js/jade-brackets.png)](http://badge.fury.io/js/jade-brackets)
+[![NPM version](https://badge.fury.io/js/jade-highlight.png)](http://badge.fury.io/js/jade-highlight)
 
@@ -19,3 +28,3 @@ ### Installation
 ```
-npm install highlight-jade
+npm install jade-highlight
 ```
@@ -26,3 +35,3 @@
 ```js
-var jade = require('highlight-jade');
+var jade = require('jade-highlight);
 
@@ -36,4 +45,25 @@ // Optionally register additional languages to highlight filters etc. (by default html, js, css and markdown are supported)
 
+## jade-code-mirror
+
+A code mirror mode for jade neatly packaged as a proper little npm module with a peer dependency.
+
+### Installation
+
+```
+npm install jade-code-mirror
+```
+
+### Usage
+
+```js
+var CodeMirror = require('jade-code-mirror');
+
+var editor = CodeMirror.fromTextArea(document.getElementById("code"), {
+  mode: 'jade',
+  lineNumbers: true
+});
+```
+
 ## License
 
 MIT

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

20033

increased by9.54%

Number of package files

4

increased by33.33%

Number of lines in readme file

66

increased by83.33%

No dependency changes