Add list of rules

index.js

@@ -64,7 +64,7 @@ function attacher(processor, options) {
         end: match[match.length - 1].position.end
       });
 
-      message.ruleId = phrase;
+      message.ruleId = phrase.replace(/\W+/g, '-');
       message.profanitySeverity = rating;
       message.source = 'retext-profanities';
     }

package.json

@@ -32,11 +32,13 @@
   "devDependencies": {
     "browserify": "^13.0.0",
     "esmangle": "^1.0.0",
+    "mdast-util-heading-range": "^2.0.1",
     "nyc": "^8.3.1",
     "remark-cli": "^2.0.0",
     "remark-preset-wooorm": "^1.0.0",
     "retext": "^4.0.0",
     "tape": "^4.0.0",
+    "unist-builder": "^1.0.2",
     "xo": "^0.16.0"
   },
   "scripts": {
@@ -63,6 +65,9 @@
   },
   "remarkConfig": {
     "output": true,
-    "presets": "wooorm"
+    "presets": "wooorm",
+    "plugins": [
+      "./script/build-table"
+    ]
   }
 }

readme.md

@@ -48,6 +48,10 @@ Check for profanities.
 
 *   `ignore` (`Array.<string>`) — phrases _not_ to warn about.
 
+## Rules
+
+See [`rules.md`][rules] for a list of rules.
+
 ## License
 
 [MIT][license] © [Titus Wormer][author]
@@ -75,3 +79,5 @@ Check for profanities.
 [profanities]: https://github.com/wooorm/profanities
 
 [cuss]: https://github.com/wooorm/cuss
+
+[rules]: rules.md