<commit_before># svg-shield

## SVG shields (badges) for node with custom text, colors, and widths.

These SVGs show how you can customize the text, both colors, and the width of each side.

![Sample Shield](https://cdn.rawgit.com/jrit/svg-shield/master/shield-pass.svg)

![Sample Shield](https://cdn.rawgit.com/jrit/svg-shield/master/shield-warn.svg)

These SVGs are based on those used by [shields.io](http://shields.io).

## Install

```bash
npm install svg-shield --save
```

## API

```js
var shield = require( "svg-shield" );
var options = { name: "name", value: "value" }; // see Options section
shield.getShield( options, function ( err, svg ) {
    // do something with svg now, for example with Express
    return res.type( "image/svg+xml" ).send( svg );
}
```

### Options

#### `nameWidth` default _90_
The width of the left side of the shield

#### `valueWidth` default _40_
The width of the right side of the shield

#### `nameBgColor` default _"#555"_<commit_msg>These should probably reference the samples in the main repo<commit_after># svg-shield

## SVG shields (badges) for node with custom text, colors, and widths.

These SVGs show how you can customize the text, both colors, and the width of each side.

![Sample Shield](https://cdn.rawgit.com/vokal/svg-shield/master/shield-pass.svg)

![Sample Shield](https://cdn.rawgit.com/vokal/svg-shield/master/shield-warn.svg)

These SVGs are based on those used by [shields.io](http://shields.io).

## Install

```bash
npm install svg-shield --save
```

## API

```js
var shield = require( "svg-shield" );
var options = { name: "name", value: "value" }; // see Options section
shield.getShield( options, function ( err, svg ) {
    // do something with svg now, for example with Express
    return res.type( "image/svg+xml" ).send( svg );
}
```

### Options

#### `nameWidth` default _90_
The width of the left side of the shield

#### `valueWidth` default _40_
The width of the right side of the shield

#### `nameBgColor` default _"#555"_
{'fraction_non_alphanumeric': 0.14364089775561098, 'fraction_numerical': 0.006982543640897756, 'mean_word_length': 4.040201005025126, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 2}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2415191', 'n_tokens_mistral': 700, 'n_tokens_neox': 639, 'n_words': 230}