Skip to content

Commit

Permalink
fix readme and email of maintainers
Browse files Browse the repository at this point in the history
Signed-off-by: Augustin Husson <[email protected]>

Co-authored-by: Julius Volz <[email protected]>
  • Loading branch information
Nexucis and juliusv committed Feb 9, 2021
1 parent 64e1289 commit 50a82a4
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 8 deletions.
2 changes: 1 addition & 1 deletion MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
* Augustin Husson <[email protected]> [@nexucis](https://github.com/Nexucis)
* Julius Volz <julius.volz@gmail.com> [@juliusv](https://github.com/juliusv)
* Julius Volz <julius.volz@promlabs.com> [@juliusv](https://github.com/juliusv)
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@

## Overview

This is a PromQL grammar for the [lezer](https://lezer.codemirror.net/) parser system. It is inspired from the initial
This is a PromQL grammar for the [lezer](https://lezer.codemirror.net/) parser system. It is inspired by the initial
grammar coming from [Prometheus](https://github.com/prometheus/prometheus/blob/master/promql/parser/generated_parser.y)
written in yacc.

This library is stable but doesn't provide any guideline of how to use it as it has been integrated
into [codemirror-promql](https://github.com/prometheus-community/codemirror-promql). If you want to use this library,
you perhaps want to use actually **codemirror-promql** instead.
you perhaps want to actually use **codemirror-promql** instead.

**Note**: This library is following the as closed as possible the changes of the vanilla grammar (i.e. coming from Prometheus)
**Note**: This library is following the changes of the upstream grammar (i.e. coming from Prometheus) as closed as possible

## Installation

This package is available as a npm package:
This package is available as an npm package:

```bash
npm install --save lezer-promql
Expand All @@ -28,9 +28,6 @@ npm install --save lezer-promql
npm install --save lezer
```

**Note 2**: In case you are using at the same time [Codemirror.next](https://codemirror.net/6/), you won't have to
install the deps **lezer** since it's already a dependency of Codemirror.next.

## Development

### Building
Expand Down

0 comments on commit 50a82a4

Please sign in to comment.