sassdoc - npm Package Compare versions

Comparing version 1.0.0-rc.10 to 1.0.0-rc.11

CHANGELOG.md

 # Changelog
 
+## 1.0.0-rc.11
+
+* Minor code improvements in bin
+* Fixed an issue with bin
+* Fixed some little bugs in view
+* Updated README
+* Changed `@datatype` to `@type`
+* Fixed a parsing bug with expanded licenses in package.json
+
 ## 1.0.0-rc.10
@@ -4,0 +13,0 @@

package.json

 {
+  "title": "SassDoc",
   "name": "sassdoc",
@@ -6,4 +7,7 @@ "description": "Like JSDoc but for Sass files.",
   "contributors": ["Fabrice Weinberg", "Valérian Galliat"],
-  "version": "1.0.0-rc.10",
-  "license": "MIT",
+  "version": "1.0.0-rc.11",
+  "license": { 
+    "type": "MIT",
+    "url": "http://opensource.org/licenses/MIT"
+  },
   "repository": {
@@ -10,0 +14,0 @@ "type": "git",

README.md

 # SassDoc
 
-SassDoc. Like JSDoc, but for Sass files.
+Like JSDoc, but for Sass files.
 
-Currently only work for `.scss` files. Also, inline comments are not parsed (`//`).
+Currently only work for `.scss` files.  
+Also, inline comments are not parsed (`//`).
 
 ## Example
 
-### Function/mixin
-
 ```scss
@@ -34,14 +33,13 @@ /**
 }
-```
 
-### Variable
-
-```scss
 /**
  * Defines whether the lib should support legacy browsers (e.g. `IE 8`).
- * ---
- * @since 0.3.9
+ * 
+ * @since 1.3.37
+ * 
  * @todo Nothing. It's awesome.
+ * 
  * @link https://github.com/HugoGiraudel/SassDoc SassDoc
- * @datatype Bool
+ * 
+ * @type Bool
  */
@@ -53,7 +51,8 @@ $legacy-support: true !global;
 
-![SassDoc](http://i.imgur.com/GnNo4HB.png)
+![SassDoc](http://i.imgur.com/4z3Bt8H.png)
 
+
 ## Installation
 
-### NPM
+### npm
 
@@ -119,3 +118,3 @@ ```sh
 
-  "package": "../package.json"
+  "package": "./package.json"
 }
@@ -131,8 +130,14 @@ ```
 
-* `name`
-* `version`
-* `license`
-* `homepage`
-* `description`
+* `title`: human name of your project
+* `name`: package name of your project (in case `title` is not defined)
+* `version`: your project's version
+* `license`: your project's license
+* `homepage`: URL to your project's homepage
+* `description`: description of your project
 
+## Built with SassDoc
+
+* [SassyIcons](http://pascalduez.github.io/SassyIcons/docs/) from Pascal Duez
+* [SassyLists](http://sassylists.com/documentation.html) from Hugo Giraudel
+
 ## Credits
@@ -139,0 +144,0 @@

No alert changes

Improved metrics

Total package byte prevSize

232452

increased by0.81%

Number of lines in readme file

147

increased by3.52%

No dependency changes