Permalink
Browse files

readme.

Signed-off-by: Nick Campbell <nicholas.j.campbell@gmail.com>
  • Loading branch information...
1 parent 1c78a78 commit f542512ff5aa8222b9e0885a28f7b12ad9990f03 @ncb000gt committed Feb 1, 2011
Showing with 25 additions and 0 deletions.
  1. +25 −0 README.md
View
25 README.md
@@ -0,0 +1,25 @@
+BBCode Parser for NodeJS
+=============
+
+This project aims to provide a robust BBCode Parser for NodeJS. Originally based on work by http://www.stonesteps.ca.
+
+
+Usage
+=============
+
+ npm install bbcode
+ var bbcode = new (require('bbcode'))({});
+ bbcode.parse('[b]text[/b]', function(content) { ... }
+
+
+TODO
+==============
+
+* lists
+* spoiler boxes
+* font face
+
+License
+==============
+
+BSD

0 comments on commit f542512

Please sign in to comment.