Skip to content

Commit 92e0613

Browse files
Added README
1 parent 99dd134 commit 92e0613

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# RegExp AST analysis
2+
3+
[![Actions Status](https://github.com/RunDevelopment/regexp-ast-analysis/workflows/Node.js%20CI/badge.svg)](https://github.com/RunDevelopment/regexp-ast-analysis/actions)
4+
[![npm](https://img.shields.io/npm/v/regexp-ast-analysis)](https://www.npmjs.com/package/regexp-ast-analysis)
5+
6+
This is a library providing functionalities to analyse [JavaScript RegExp](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp).
7+
8+
All functions operate on AST nodes produced by [regexpp](https://github.com/mysticatea/regexpp). Characters are parsed by [refa](https://github.com/RunDevelopment/refa).
9+
10+
## Usage
11+
12+
Install the library using npm:
13+
14+
```bash
15+
npm i regexp-ast-analysis
16+
```
17+
18+
Import the library:
19+
20+
```js
21+
import * as RAA from "regexp-ast-analysis";
22+
```
23+
24+
## Documentation
25+
26+
Links to the full API documentation:
27+
28+
- [Latest release](https://rundevelopment.github.io/regexp-ast-analysis/docs/latest/)
29+
- [Development](https://rundevelopment.github.io/regexp-ast-analysis/docs/dev/)

0 commit comments

Comments
 (0)