add inline rules readme

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

Hide file tree

Showing 4 changed files with 16 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ Quick start
         htmlhint --help
         htmlhint test.html
 
-2. result
+2. results
 
            test.html
               L5 |    </head>
@@ -35,7 +35,7 @@ Quick start
 
 3. config rules
 
-    search `.htmlhintrc` file in current directory and all parents directory:
+    search `.htmlhintrc` file in current directory and all parent directorys:
 
         htmlhint
         htmlhint test.html
@@ -48,6 +48,13 @@ Quick start
 
         htmlhint --rules tag-pair,id-class-value=underline test.html
 
+    Inline rules in `test.html`:
+
+        <!--htmlhint tag-pair,id-class-value:underline -->
+        <html>
+        <head>
+            ...
+
 Guide
 =======================
 

diff --git a/bin/htmlhint b/bin/htmlhint
@@ -22,15 +22,15 @@ function map(val) {
 program.on('--help', function(){
     console.log('  Examples:');
     console.log('');
-    console.log('    htmlhint -l');
-    console.log('    htmlhint -r tag-pair,id-class-value=underline test.html');
-    console.log('    htmlhint -c .htmlhintrc test.html');
+    console.log('    htmlhint --list');
+    console.log('    htmlhint --rules tag-pair,id-class-value=underline test.html');
+    console.log('    htmlhint --config .htmlhintrc test.html');
     console.log('');
 });
 
 program
     .version(pkg.version)
-    .usage('[options] <file ...>')
+    .usage('<file ...> [options]')
     .option('-l, --list', 'show all of the rules available.')
     .option('-c, --config <file>', 'custom configuration file.')
     .option('-r, --rules <ruleid, ruleid=value ...>', 'set all of the rules available.', map)