Skip to content

Commit 4d28215

Browse files
committed
Docs: drop browser section, add note about bundling into jscs
1 parent 842dcb5 commit 4d28215

File tree

1 file changed

+2
-24
lines changed

1 file changed

+2
-24
lines changed

README.md

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,11 @@
1616
- [Versioning & Semver](#versioning--semver)
1717
- [Usage](#usage)
1818
- [Rules](#rules)
19-
- [Browser Usage](#browser-usage)
2019

2120
## Plugin installation
2221

22+
**NB** Since `jscs v2.0` the plugin `jscs-jsdoc` is bundled into it.
23+
2324
`jscs-jsdoc` can be installed using NPM and requires [jscs](https://github.com/jscs-dev/node-jscs/#installation).
2425

2526
Install it globally if you are using globally installed `jscs`
@@ -961,26 +962,3 @@ function method() {
961962
return false;
962963
}
963964
```
964-
965-
966-
## Browser Usage
967-
968-
NOT SUPPORTED ATM. SORRY.
969-
970-
File [jscs-jsdoc-browser.js](jscs-jsdoc-browser.js) contains browser-compatible version of `jscs-jsdoc`.
971-
972-
Download and include `jscs-jsdoc-browser.js` into your page just after `jscs-browser.js`.
973-
974-
```html
975-
<script src="jscs-browser.js"></script>
976-
<script src="jscs-jsdoc-browser.js"></script>
977-
<script>
978-
var checker = new JscsStringChecker();
979-
checker.registerDefaultRules();
980-
checker.configure({'jsDoc': {/* ... */}});
981-
var errors = checker.checkString('var x, y = 1;');
982-
errors.getErrorList().forEach(function (error) {
983-
console.log(errors.explainError(error));
984-
});
985-
</script>
986-
```

0 commit comments

Comments
 (0)