<commit_before># url-slug [![build status](https://img.shields.io/travis/stldo/url-slug/master)](https://travis-ci.org/stldo/url-slug) [![npm](https://img.shields.io/npm/v/url-slug)](https://www.npmjs.com/package/url-slug)

- __Less than 1kB__ minified and gzipped;
- __RFC 3986__ compliant, compatible with URL hosts, paths, queries and fragments;
- Supports __custom dictionaries__ to replace characters;
- Easily __revert slugs__ with useful options.

## Install

```bash
$ npm install url-slug
```

## Usage

```javascript
import urlSlug from 'url-slug'

urlSlug('Sir <NAME> MBE is an English singer-songwriter')
// sir-james-paul-mc-cartney-mbe-is-an-english-singer-songwriter
```

## Documentation

### urlSlug(string[, options]), convert(string[, options])

Returns `string` value converted to a slug.
<commit_msg>Update: readme content<commit_after># url-slug [![build status](https://img.shields.io/travis/stldo/url-slug/master)](https://travis-ci.org/stldo/url-slug) [![npm](https://img.shields.io/npm/v/url-slug)](https://www.npmjs.com/package/url-slug)

- __Less than 1kB__ minified and gzipped;
- __RFC 3986__ compliant, compatible with URL hosts, paths, queries and fragments;
- Supports __custom dictionaries__ to replace characters;
- Easily __revert slugs__.

## Install

```bash
$ npm install url-slug
```

## Usage

```javascript
import urlSlug from 'url-slug'

urlSlug('Sir <NAME> MBE is an English singer-songwriter')
// sir-james-paul-mc-cartney-mbe-is-an-english-singer-songwriter
```

## Documentation

### urlSlug(string[, options]), convert(string[, options])

Returns `string` value converted to a slug.

{'fraction_non_alphanumeric': 0.15757204169221337, 'fraction_numerical': 0.0061312078479460455, 'mean_word_length': 4.870503597122302, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 8, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, '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': '548655', 'n_tokens_mistral': 613, 'n_tokens_neox': 576, 'n_words': 129}