From f72d1a270ddc69bbc07ecc3731035fa81c8fa3d8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Georges=20Dup=C3=A9ron?= Date: Sat, 27 Aug 2016 00:27:15 +0200 Subject: [PATCH] Filled in README --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 98e94aa..123ec1e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ +[![Build Status,](https://img.shields.io/travis/jsmaniac/extensible-parser-specifications/master.svg)](https://travis-ci.org/jsmaniac/extensible-parser-specifications) +[![Coverage Status,](https://img.shields.io/coveralls/jsmaniac/extensible-parser-specifications/master.svg)](https://coveralls.io/github/jsmaniac/extensible-parser-specifications) +[![Build Stats.](https://img.shields.io/badge/build-stats-blue.svg)](http://jsmaniac.github.io/travis-stats/#jsmaniac/extensible-parser-specifications) + extensible-parser-specifications ================================ -README text here. + +Like https://github.com/AlexKnauth/seq-no-order, but provides global +constraints. AlexKnauth's implementation allows dotted "rest" pattern which +this implementation does not support. + +This package is unstable, and its API may change at any moment. Once it is +stable enough, it may be merged into [Alex Knauth's +implementation](https://github.com/AlexKnauth/seq-no-order). + +The following pattern expanders for `syntax/parse` are defined: +* ~no-order +* ~post-check +* ~post-fail +* ~nop +* ~optional/else +* ~global-or +* ~global-and +* ~global-counter +