# regexplained

> The module for rendering diagrams on regexplained.co.uk

Latest version **1.0.0** (published 2013-03-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install regexplained
pnpm add regexplained
yarn add regexplained
bun add regexplained
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2013-03-25 |
| First published | 2013-03-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | ForbesLindesay |
| Maintainers | forbeslindesay |
| Keywords | regexp, regular, expression, diagram, svg, regexper |

## Links

- npm: https://www.npmjs.com/package/regexplained
- Repository: https://github.com/ForbesLindesay/regexplained
- npm.io page: https://npm.io/package/regexplained

## Dependencies (1)

- [raphael](https://npm.io/package/raphael.md) ~2.1.0

## Recent versions

- 1.0.0 (latest) — 2013-03-25

## README

# regexplained

The module for rendering diagrams on regexplained.co.uk

This module is designed to work on the client side in browserify.  If anyone can submit a pull request that makes this work in node.js as well (with decent cross platform support) I'll gladly accept it.

## Usage

index.js

```javascript
var regexplained = require('regexplained');
var paperContainer = document.getElementById('container');
regexplained(paperContainer, '[0-9][0-9][a-z]+', function(e) {
    if (e) {
      alert(e.stack || e.message);
      throw e;
    } else {
      //done
    }
  });
```

index.html

```html
<div id="container"></div>
<script src="bundle.js"></script>
```

In a console:

```
$ npm install regexplained
$ browserify index.js > bundle.js
```

## License

MIT

---
_Source: https://npm.io/package/regexplained · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._