Permalink
Browse files

Extend README

  • Loading branch information...
1 parent c2e1cc1 commit aec3cc765677776541d6855c32fc5f624570d7b3 @Pita committed May 29, 2011
Showing with 5 additions and 1 deletion.
  1. +5 −1 README.md
View
@@ -1,12 +1,16 @@
#About
I created doc.md cause all the jsdoc tools I found were too complex or doesn't do what I wanted. So I decided to create my own jsdoc tool. It creates markdown, this makes it possible to look at the documentation directly in Github.
+#Example
+
+[test.js](https://github.com/Pita/doc.md/blob/master/exampleSRC/blub/test.js) -> [test.md](https://github.com/Pita/doc.md/blob/master/exampleDOC/blub/test.md)
+
#Install
`npm install -g doc.md`
#Usage
-doc.md $SRCFOLDER $DESTFOLDER
+`doc.md $SRCFOLDER $DESTFOLDER`
#LICENSE
Apache License v2 <http://www.apache.org/licenses/LICENSE-2.0.html>

0 comments on commit aec3cc7

Please sign in to comment.