more documentation

.eslintrc

@@ -1,7 +1,7 @@
 {
   "extends": "eslint:recommended",
   "env": {
-    "node": true,
+    "node": true
   },
   "rules": {
     "comma-dangle": [2, "always-multiline"],
@@ -23,6 +23,6 @@
     "space-after-keywords": [2, "always"],
     "space-before-blocks": [2, "always"],
     "space-in-parens": [2, "never"],
-    "space-unary-ops": 2,
+    "space-unary-ops": 2
   }
 }

CHANGELOG.md

@@ -1,3 +1,3 @@
-## 0.1.0+
+## 1.0.0
 
-- Initial experimentation.
+- Initial Version

README.md

@@ -1,10 +1,44 @@
-# Stylint Nitro Bem
+# Stylelint BEM Namics
 
-Verifies that the given css follows the nitro bem rules.
+Verifies that the given css follows the namics BEM rules.
 
 ![screenshot](https://raw.githubusercontent.com/namics/stylelint-bem-namics/master/example.png)
 
-##Valid examples
+## Installation
+
+```
+npm install @namics/stylelint-bem --save-dev
+```
+
+## Configuration
+
+### Simple configuration
+```js
+{
+  "plugins": [
+    "@namics/stylelint-bem"
+  ],
+  "rules": {
+    "plugin/stylelint-bem-namics": true,
+  }
+}
+```  
+
+### Advanced configuration
+```js
+{
+  "plugins": [
+    "@namics/stylelint-bem"
+  ],
+  "rules": {
+    "plugin/stylelint-bem-namics": {
+      "namespace": "ux-"
+    },
+  }
+}
+```  
+
+## Valid examples
 
 ```css
 .a-block {}
@@ -43,6 +77,7 @@ Verifies that the given css follows the nitro bem rules.
 .state-h-block--state-name {}
 ```
 
+
 ## Exception
 
 Whenever you will apply rules you will run into edge cases like third-party code or wysiwyg content where those rules have to be bent a little bit.
@@ -59,34 +94,6 @@ the linting again:
     }
 ```
 
-## Configuration
-
-### Simple configuration
-```js
-{
-  "plugins": [
-    "@namics/stylelint-bem"
-  ],
-  "rules": {
-    "plugin/stylelint-bem-namics": true,
-  }
-}
-```  
-
-### Advanced configuration
-```js
-{
-  "plugins": [
-    "@namics/stylelint-bem"
-  ],
-  "rules": {
-    "plugin/stylelint-bem-namics": {
-      "namespace": "ux-"
-    },
-  }
-}
-```  
-
 ## Changelog
 
 Please see the [CHANGELOG.md](https://github.com/namics/stylelint-bem-namics/blob/master/CHANGELOG.md)

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@namics/stylelint-bem-plugin",
+  "name": "@namics/stylelint-bem",
   "version": "1.0.0",
   "description": "A stylelint plugin for the Namics BEM definitions",
   "main": "index.js",
@@ -10,7 +10,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/namics/stylelint-bem.git"
+    "url": "https://github.com/namics/stylelint-bem-namics.git"
   },
   "files": [
     "index.js"