Skip to content

Commit de4489a

Browse files
authored
New header and mention creator
1 parent b09bd82 commit de4489a

File tree

1 file changed

+38
-4
lines changed

1 file changed

+38
-4
lines changed

readme.md

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,35 @@
1-
# What is chai-htmlhint
2-
chai-htmlhint is a wrapper of [htmlhint](https://github.com/yaniswang/HTMLHint/) to use with chai.
1+
<h1 align="center">
2+
<br>
3+
Chai HTMLHint
4+
<br>
5+
</h1>
36

4-
# How to use it
7+
<h4 align="center">Extends Chai with assertions for HTMLHint</h4>
8+
9+
<p align="center">
10+
<a href="https://travis-ci.org/htmlhint/chai-htmlhint">
11+
<img src="https://img.shields.io/travis/htmlhint/chai-htmlhint.svg" alt="Travis Build Status">
12+
</a>
13+
<a href="https://codecov.io/gh/htmlhint/chai-htmlhint>
14+
<img src="https://codecov.io/gh/htmlhint/chai-htmlhint/branch/master/graph/badge.svg" alt="Codecov">
15+
</a>
16+
<a href="https://www.npmjs.com/package/chai-htmlhint">
17+
<img src="https://img.shields.io/npm/dm/chai-htmlhint.svg" alt="NPM count">
18+
</a>
19+
<img src="https://badgen.net/badge/license/MIT/green" alt="MIT Licence" />
20+
<a href="https://discord.gg/nJ6J9CP">
21+
<img src="https://img.shields.io/badge/chat-on%20discord-7289da.svg" alt="Chat">
22+
</a>
23+
<a href="http://roadmap.htmlhint.io/roadmap">
24+
<img src="https://img.shields.io/badge/check-our%20roadmap-EE503E.svg" alt="Chat">
25+
</a>
26+
</p>
27+
28+
<p align="center">
29+
  <a href="#usage">How To Use</a> • <a href="/CONTRIBUTING.md">Contributing</a> • <a href="http://roadmap.htmlhint.io/">Roadmap</a> • <a href="https://htmlhint.io">Website</a>
30+
</p>
31+
32+
# Usage
533
You just have to pass the html you want to validate like this:
634
```javascript
735
var myhtml = '<h1>my html</h1>';
@@ -32,4 +60,10 @@ The default rules are:
3260
};
3361
```
3462

35-
If you want to override you just need a valid `.htmlhintrc` file in the root of your project
63+
If you want to override you just need a valid `.htmlhintrc` file in the root of your project
64+
65+
## LICENCE
66+
67+
Project initially created by [@molant](https://github.com/molant) and transferred to the [HTMLHint](https://github.com/htmlhint) organization.
68+
69+
[MIT License](./LICENSE)

0 commit comments

Comments
 (0)