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