Permalink
Browse files

Merge pull request #16 from domenic/patch-1

Update readme to reflect the move
  • Loading branch information...
2 parents bb338d4 + ed4e42b commit cef341da872681d031e7e6d7ed0e4718aab608be @substack committed Jan 12, 2014
Showing with 4 additions and 84 deletions.
  1. +4 −84 README.markdown
View
@@ -1,87 +1,7 @@
-jadeify
-=======
+# Jadeify Has Moved
-Browserify middleware for browser-side jade templates.
+Jadeify was not being kept up to date with the latest advances in browserify magic, so we moved it to [domenic/jadeify](https://github.com/domenic/jadeify). It is now a Browserify 2.x/3.x transform, instead of a Connect middleware.
-usage
-=====
+You can still get old releases from npm; everything in the 0.x range is derived from this repository.
-For some expresso/connect/etc application `app`:
-
-````javascript
-var browserify = require('browserify');
-var jadeify = require('jadeify');
-
-var bundle = browserify()
- .use(jadeify(__dirname + '/views'))
- .addEntry(__dirname + '/main.js')
-;
-app.use(bundle);
-````
-
-Then in your browser-side main.js entry point you can use `jadeify()`:
-
-````javascript
-var $ = require('jquery');
-var jadeify = require('jadeify');
-
-var msg = jadeify('msg.jade', {
- title : 'foo',
- body : 'bar baz quux'
-}).appendTo($('#messages'));
-````
-
-[See here](https://github.com/substack/node-jadeify/tree/master/example/simple)
-for a more complete example.
-
-server-side methods
-===================
-
-jadeify(viewdir, opts or extension)
------------------------------------
-
-Use templates from `viewdir` or `opts.views` with file extension `extension` or
-`opts.extension` or otherwise any file.
-
-The options are passed along to
-[fileify](http://github.com/substack/node-fileify).
-
-One thing you might want to pass along to fileify is the watch parameter to
-update the jadeified view files when they change on disk without restarting the
-server.
-
-browser-side methods
-====================
-
-jadeify(templateFile, vars={})
-------------------------------
-
-Render `templateFile` with `vars` local variables.
-
-The `vars` parameter undergoes a deep traversal to find HTMLElement and jquery
-handles in order to stringify their outerHTMLs so you can just `!{varname}` to
-insert elements into a template.
-
-Returns an HTML DOM element wrapped with jquery.
-
-template methods
-================
-
-These methods are available to your template logic.
-
-$ (jquery handle)
------------------
-
-The jquery function is passed in as `$`.
-
-installation
-============
-
-With [npm](http://npmjs.org), do:
-
- npm install jadeify
-
-license
-=======
-
-MIT/X11
+If you want to see the README before this move [GitHub has you covered](https://github.com/substack/node-jadeify/blob/bb338d4df7ae466a57e666a985466af3f30918f2/README.markdown).

0 comments on commit cef341d

Please sign in to comment.