beardcss - npm Package Compare versions

Comparing version 2.0.15 to 2.1.0

bower.json

@@ -7,3 +7,3 @@ {
   ],
-  "version": "2.0.15",
+  "version": "2.1.0",
   "homepage": "https://github.com/monarkee/beard",
@@ -10,0 +10,0 @@ "authors": [

package.json

 {
   "name": "beardcss",
-  "version": "2.0.15",
+  "version": "2.1.0",
   "description": "A CSS framework for people with better things to do",
@@ -5,0 +5,0 @@ "main": "beard.scss",

README.md

@@ -7,1 +7,36 @@ Beard
 Beard focuses on developer speed, maintenance, and ease-of-use, versus "pretty" markup.
+
+## Installation
+
+Beard can be installed via [NPM](https://www.npmjs.com) or [Bower](bower.io), but just use [NPM](https://www.npmjs.com). Seriously.
+
+```$ npm install beardcss```
+
+```$ bower install beard```
+
+---
+
+### Adding Beard into your project
+
+### The Recommended Way
+
+The best way to add Beard to your project is to copy the contents of <code>beard/beard.scss</code> to your main Sass file. This allows for the best source ordering. From there, we recommend adding your site styles between the "Objects" and "Helpers" sections, like so:
+
+```scss
+// Objects
+...
+
+// Your styles go here
+
+// Helpers
+...
+```
+
+> **Note**: Don&rsquo;t forget to change the import paths to where you installed Beard.
+
+---
+
+### Or&hellip;Just the Dead Simple Installation
+
+Or you could just import it directly. We don't recommend it, but if you need something quick, go ahead!
+```@import '../node_modules/beardcss/beard'```

No alert changes

Improved metrics

Total package byte prevSize

289841

increased by5.95%

Lines of code

931

increased by6.16%

Number of lines in readme file

42

increased by500%

No dependency changes