From 50a82a438ff7f1086ad43fa76864e0397d85dbdd Mon Sep 17 00:00:00 2001 From: Augustin Husson Date: Tue, 9 Feb 2021 18:35:25 +0100 Subject: [PATCH] fix readme and email of maintainers Signed-off-by: Augustin Husson Co-authored-by: Julius Volz --- MAINTAINERS.md | 2 +- README.md | 11 ++++------- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 125c020..4d8a822 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -1,2 +1,2 @@ * Augustin Husson [@nexucis](https://github.com/Nexucis) -* Julius Volz [@juliusv](https://github.com/juliusv) +* Julius Volz [@juliusv](https://github.com/juliusv) diff --git a/README.md b/README.md index 2195342..f0bf03d 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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