.gitignore added
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / svg-tags / README.md
1 SVG Tags
2 ========
3 [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage][coveralls-image]][coveralls-url] [![Dependencies][dependencies-image]][dependencies-url]
4
5 > List of standard SVG tags.
6
7 List built from the [SVG 1.1 specification](http://www.w3.org/TR/SVG/eltindex.html).
8
9
10 ## Installation
11
12 ``` bash
13 $ npm install svg-tags --save
14 ```
15
16
17 ## Usage
18
19 The module is simply a JSON array, so use as you would a normal JavaScript array.
20
21 ``` javascript
22 var tags = require( 'svg-tags' );
23
24 console.log( JSON.stringify( tags ) );
25 /**
26 * Returns:
27 *       [ 'a', 'altGlyph', ... ]
28 */
29
30 console.log( tags.indexOf( 'desc' ) );
31 // Returns [index]
32 ```
33
34 ## Examples
35
36 To run the example code from the top-level application directory,
37
38 ``` bash
39 $ node ./examples/index.js
40 ```
41
42
43 ## Tests
44
45 ### Unit
46
47 Unit tests use the [Mocha](http://visionmedia.github.io/mocha) test framework with [Chai](http://chaijs.com) assertions. To run the tests, execute the following command in the top-level application directory:
48
49 ``` bash
50 $ make test
51 ```
52
53 All new feature development should have corresponding unit tests to validate correct functionality.
54
55
56 ### Test Coverage
57
58 This repository uses [Istanbul](https://github.com/gotwarlost/istanbul) as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
59
60 ``` bash
61 $ make test-cov
62 ```
63
64 Istanbul creates a `./reports/coverage` directory. To access an HTML version of the report,
65
66 ``` bash
67 $ open reports/coverage/lcov-report/index.html
68 ```
69
70
71 ## License
72
73 [MIT license](http://opensource.org/licenses/MIT). 
74
75
76 ---
77 ## Copyright
78
79 Copyright © 2014. Athan Reines.
80
81
82
83 [npm-image]: http://img.shields.io/npm/v/svg-tags.svg
84 [npm-url]: https://npmjs.org/package/svg-tags
85
86 [travis-image]: http://img.shields.io/travis/element-io/svg-tags/master.svg
87 [travis-url]: https://travis-ci.org/element-io/svg-tags
88
89 [coveralls-image]: https://img.shields.io/coveralls/element-io/svg-tags/master.svg
90 [coveralls-url]: https://coveralls.io/r/element-io/svg-tags?branch=master
91
92 [dependencies-image]: http://img.shields.io/david/element-io/svg-tags.svg
93 [dependencies-url]: https://david-dm.org/element-io/svg-tags
94
95 [dev-dependencies-image]: http://img.shields.io/david/dev/element-io/svg-tags.svg
96 [dev-dependencies-url]: https://david-dm.org/dev/element-io/svg-tags
97
98 [github-issues-image]: http://img.shields.io/github/issues/element-io/svg-tags.svg
99 [github-issues-url]: https://github.com/element-io/svg-tags/issues