aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAkshay Nair <phenax5@gmail.com>2022-02-17 22:01:21 +0530
committerAkshay Nair <phenax5@gmail.com>2022-02-17 22:01:21 +0530
commit054098eb896556ac2055663e2b4326df8998b975 (patch)
tree869159f5d7e4f1fa4176749728e93c4fd570bf39 /README.md
parentf4f24dfbad6bde35cd891625077959019bfd8aca (diff)
downloadelxr-054098eb896556ac2055663e2b4326df8998b975.tar.gz
elxr-054098eb896556ac2055663e2b4326df8998b975.zip
docs: readme update
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 21 insertions, 5 deletions
diff --git a/README.md b/README.md
index eb2c9ee..157b4d2 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,21 @@
Regular expression-like syntax for list operations. An experiment generalizing regex-like operations to a list.
-[![forthebadge](https://forthebadge.com/images/badges/you-didnt-ask-for-this.svg)](https://forthebadge.com)
-[![forthebadge](https://forthebadge.com/images/badges/kinda-sfw.svg)](https://forthebadge.com)
-[![forthebadge](https://forthebadge.com/images/badges/0-percent-optimized.svg)](https://forthebadge.com)
+[![npm](https://img.shields.io/npm/v/elxr?style=for-the-badge)](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)
+