Skip to content

Commit

Permalink
Add readme and npm manifest.
Browse files Browse the repository at this point in the history
  • Loading branch information
gamefreak committed Aug 30, 2012
1 parent bdba55b commit d990896
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
16 changes: 16 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
SnuOwnd markdown parser
=================

SnuOwnd is an exact as possible JavaScript port of [Reddit](http://reddit.com)'s [Snudown](http://github.com/reddit/snudown) markdown parser.



Use
---

SnuOwnd can either be used in a browser as a drop in library, or used with node.js by `var SnuOwnd = require('snuownd');`

Use is simple as:

var markdown = "...";
var html = SnuOwnd.getParser().render(markdown);
18 changes: 18 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"name": "snuownd",
"version": "0.1.0",
"description": "JavaScript port of Reddit's SnuDown Markdown parser.",
"main": "snuownd.js",
"scripts": {
"test": "node test.js"
},
"repository": {
"type": "git",
"url": "git://github.com/gamefreak/snuownd.git"
},
"keywords": [
"markdown"
],
"author": "Scott McClaugherty",
"license": "MIT"
}

0 comments on commit d990896

Please sign in to comment.