add Quick start

htmlhint · Oct 7, 2015 · 8c498ee · 8c498ee
1 parent 2247853
commit 8c498ee
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -13,6 +13,41 @@ HTMLHint is a Static Code Analysis Tool for HTML, you can use it with IDE or in
 
 Official Site: [http://htmlhint.com/](http://htmlhint.com/)
 
+Quick start
+======================
+
+1. install & hint
+
+        npm install htmlhint -g
+        htmlhint -V
+        htmlhint --help
+        htmlhint test.html
+
+2. result
+
+           test.html
+              L5 |    </head>
+                      ^ <title> must be present in <head> tag. (title-require)
+              L8 |    </body>
+                      ^ Tag must be paired, missing: [ </div> ], start tag match failed [ <div> ] on line 7. (tag-pair)
+
+        2 errors in 1 files
+
+3. config rules
+
+    search `.htmlhintrc` file in current directory and all parents directory:
+
+        htmlhint
+        htmlhint test.html
+
+    custom config file:
+
+        htmlhint --config htmlhint.conf test.html
+
+    custom rules:
+
+        htmlhint --rules tag-pair,id-class-value=underline test.html
+
 Guide
 =======================
 

diff --git a/bin/htmlhint b/bin/htmlhint
@@ -56,12 +56,11 @@ quit(processFiles(arrAllFiles, ruleset, jsonOutput));
 function listRules(){
     var rules = HTMLHint.rules;
 	var rule;
-    console.log('\r\nAll rules:');
-    console.log('======================================');
+    console.log('     All rules:');
+    console.log(' ==================================================');
     for (var id in rules){
         rule = rules[id];
-        console.log('\r\n'+rule.id+' :');
-        console.log('    '+rule.description);
+        console.log('     %s : %s', rule.id.green, rule.description);
     }
 }