diff options
| author | Akshay Nair <phenax5@gmail.com> | 2022-02-17 22:01:21 +0530 |
|---|---|---|
| committer | Akshay Nair <phenax5@gmail.com> | 2022-02-17 22:01:21 +0530 |
| commit | 054098eb896556ac2055663e2b4326df8998b975 (patch) | |
| tree | 869159f5d7e4f1fa4176749728e93c4fd570bf39 | |
| parent | f4f24dfbad6bde35cd891625077959019bfd8aca (diff) | |
| download | elxr-054098eb896556ac2055663e2b4326df8998b975.tar.gz elxr-054098eb896556ac2055663e2b4326df8998b975.zip | |
docs: readme update
| -rw-r--r-- | README.md | 26 | ||||
| -rw-r--r-- | package.json | 3 |
2 files changed, 23 insertions, 6 deletions
@@ -2,12 +2,21 @@ Regular expression-like syntax for list operations. An experiment generalizing regex-like operations to a list. -[](https://forthebadge.com) -[](https://forthebadge.com) -[](https://forthebadge.com) +[](https://www.npmjs.com/package/elxr) -### Syntax +## Install +To install the latest stable version of elxr - + +```bash +yarn add elxr +// OR +npm install --save elxr +``` + + + +## Syntax Whitespaces are ignored (except within literals) * `\s` => Any **string** @@ -34,9 +43,10 @@ Whitespaces are ignored (except within literals) * `(?: \s\T)` => Non-capturing group (example checks for `\s\T` but doesn't return it as a match) <sup>[TODO]</sup> -### Examples +## Examples + #### matchAll ```js @@ -95,3 +105,9 @@ replaceAll(/ \n+ /, replacer, [ 'start', 3, 5, 'mid', 2, 0, 4, 'end' ]) // > [ 'start', 8, 'mid', 6, 'end' ] ``` + + + +## License +Elxr is licensed under [MIT](./LICENSE) + diff --git a/package.json b/package.json index 520ea2c..b58017f 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,13 @@ { "name": "elxr", "version": "0.0.0", - "description": "__", + "description": "Regular expression-like syntax generalized for list operations", "main": "lib/index.js", "types": "lib/index.d.ts", "repository": "https://github.com/phenax/elxr.git", "author": "Akshay Nair <phenax5@gmail.com>", "license": "MIT", + "keywords": ["regex", "regular", "expressions", "list", "typescript"], "scripts": { "tsc": "tsc --emitDeclarationOnly --outDir lib", "test": "jest", |
