minimal-jsdoc - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "minimal-jsdoc",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Minimal template for JSDoc 3",
   "main": "Gruntfile.js",
-  "dependencies": {
-  },
+  "dependencies": {},
   "devDependencies": {
@@ -9,0 +8,0 @@ "connect-livereload": "~0.3.2",

README.md

@@ -1,24 +0,20 @@
-Jaguar.js template for JSDoc 3
+Minimal template for JSDoc 3
 ---
-- [Jaguar.js](http://davidshimjs.github.io/jaguarjs)
-- [Jaguar.js Documentations](http://davidshimjs.github.io/jaguarjs/doc)
-- [JSDoc3](https://github.com/jsdoc3/jsdoc)
-- [JSDoc3 API Documentations](http://usejsdoc.org)
+A minimal template for creating clean documentation for one-namespace libraries.
 
+See a [demo](https://rawgit.com/chiedolabs/objob/master/docs/ob.html).
+
+Currently, I need to fix a bug where index.html is blank. For now, you will need to visit YOURNAMESPACE.html for your documentation.
+
+This is still a beta and hasn't been heavily field tested.
+
 Usage
 ---
-1. If you want to create documentations with sample files, you can use commands below.
-```
-$ npm install
-$ grunt demo
-```
 
-2. You can see any output related jsdoc process with a `--debug` flag.
 ```
-$ grunt demo --debug
+npm install --save-dev minimal-jsdoc
 ```
 
-3. If you already have jsdoc system, you can use this project as jsdoc template.
 ```
-$ jsdoc -t `project folder` -c `configuration file` `source files` `README.md file`
+$ jsdoc -t .node_modules/minimal-jsdoc -c `configuration file` `source files` `README.md file`
 ```
@@ -32,2 +28,3 @@
 "templates": {
+	"version": "1.0.0",
     "applicationName": "Demo",
@@ -52,2 +49,6 @@ "disqus": "",
 
+Credits
+---
+Many credits go to davidshimjs as this is a fork of [davidshimjs/jaguarjs-jsdoc](https://github.com/davidshimjs/jaguarjs-jsdoc)
+
 License
@@ -57,3 +58,1 @@ ---
 
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/davidshimjs/jaguarjs-jsdoc/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
-

No alert changes

Worsened metrics

Total package byte prevSize

624936

decreased by-0.02%

Number of lines in readme file

56

decreased by-1.75%

No dependency changes