Merge pull request #31 from Offirmo/patch-1

README.md: fix "use with chai-as-promised" displayed incorrectly + make the "caveats" sections linkable
prodatakey · Mar 12, 2018 · bb5d007 · bb5d007
2 parents 53a0def + ba7d6a6
commit bb5d007
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -45,7 +45,7 @@ The following built-in assertions are modified by this plugin to now use the fun
 
 ## Caveats
 
-**Always terminate with a function**
+### Always terminate with a function
 
 These forms can also be mixed, but the chain must always be terminated in the function form or assertions up to that point in the chain will not execute.
 
@@ -54,7 +54,7 @@ expect(true).to.be.true.and.not.false();
 expect(true).to.be.true().and.not.false();
 ```
 
-**Chaining length/arguments**
+### Chaining length/argument
 
 This breaks both the `length` and `arguments` asserts when they are in the chain following any other assertion. To work around this limitation, do the `length` or `arguments` asserts first in the chain or just do multiple assertion statements.
 
@@ -66,7 +66,7 @@ myArray.should.exist();
 myArray.should.have.length(3);
 ```
 
-** use with chai-as-promised **
+### use with chai-as-promised
 
 If you're using chai-as-promised, you should `.use` chai-as-promised before dirty-chai: