Skip to content

Commit 249b2ae

Browse files
author
Nico Oelgart
committed
Update README.md
1 parent e1bcac2 commit 249b2ae

File tree

1 file changed

+34
-6
lines changed

1 file changed

+34
-6
lines changed

README.md

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
## Rules Parser and Evaluator for PHP 5.4+
22

3-
[![Build Status](https://travis-ci.org/nicoSWD/php-rule-parser.svg?branch=v0.3)](https://travis-ci.org/nicoSWD/php-rule-parser) [![Code Coverage](https://scrutinizer-ci.com/g/nicoSWD/php-rule-parser/badges/coverage.png?b=v0.3)](https://scrutinizer-ci.com/g/nicoSWD/php-rule-parser/?branch=v0.3) [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/nicoswd/php-rule-parser.svg?b=v0.3)](https://scrutinizer-ci.com/g/nicoSWD/php-rule-parser/?branch=v0.3) [![HHVM tested](https://img.shields.io/hhvm/nicoswd/php-rule-parser.svg)](https://travis-ci.org/nicoSWD/php-rule-parser) [![Latest Stable Version](https://img.shields.io/packagist/v/nicoswd/php-rule-parser.svg)](https://packagist.org/packages/nicoswd/php-rule-parser)
3+
| [Master][Master] | [Develop][Develop] | [0.3][0.3] |
4+
|:----------------:|:----------:|:----------:|
5+
| [![Build status][Master image]][Master] | [![Build status][Develop image]][Develop] | [![Build status][0.3 image]][0.3] |
6+
| [![Coverage Status][Master coverage image]][Master coverage] | [![Coverage Status][Develop coverage image]][Develop coverage] | [![Coverage Status][0.3 coverage image]][0.3 coverage] |
7+
| [![Code Quality][Master quality image]][Master quality] | [![Code Quality][Develop quality image]][Develop quality] | [![Code Quality][0.3 quality image]][0.3 quality] |
8+
9+
[![HHVM tested](https://img.shields.io/hhvm/nicoswd/php-rule-parser.svg)](https://travis-ci.org/nicoSWD/php-rule-parser) [![Latest Stable Version](https://img.shields.io/packagist/v/nicoswd/php-rule-parser.svg)](https://packagist.org/packages/nicoswd/php-rule-parser)
410

511
You're looking at a PHP library to parse and evaluate text based rules with a Javascript-like syntax. This project was born out of the necessity to evaluate hundreds of rules that were originally written and evaluated in JavaScript, and now needed to be evaluated on the server-side, using PHP.
612

@@ -15,12 +21,12 @@ Find me on Twitter: @[nicoSWD](https://twitter.com/nicoSWD)
1521

1622
Via Composer
1723

18-
``` bash
24+
```bash
1925
$ composer require "nicoswd/php-rule-parser": "0.3.*"
2026
```
2127

2228
Via git
23-
``` bash
29+
```bash
2430
$ git clone git@github.com:nicoSWD/php-rule-parser.git
2531
```
2632

@@ -148,15 +154,14 @@ If you discover any security related issues, please email security@nic0.me inste
148154

149155
## Testing
150156

151-
``` bash
157+
```bash
152158
$ phpunit
153159
```
154160

155161
## Contributing
156162
Pull requests are very welcome! If they include tests, even better. This project follows PSR-2 coding standards, please make sure your pull requests do too.
157163

158164
## To Do
159-
- Add support for function calls
160165
- Support for object properties (foo.length)
161166
- Support for returning actual results, other than true or false
162167
- Support for array / string dereferencing: "foo"[1]
@@ -166,11 +171,34 @@ Pull requests are very welcome! If they include tests, even better. This project
166171
- Do math (?)
167172
- Allow string concatenating with "+"
168173
- Support for objects {} (?)
169-
- Support for regular expressions
174+
- Invalid regex modifiers should not result in an unknown token
175+
- Duplicate regex modifiers should throw an error
176+
- ~~Add support for function calls~~
177+
- ~~Support for regular expressions~~
170178
- ~~Fix build on PHP 7 / Nightly~~
171179
- ~~Allow variables in arrays~~
180+
- ~~Verify function and method name spelling (.tOuPpErCAse() is currently valid)~~
172181
- ...
173182

174183
## License
175184

176185
[![License](https://img.shields.io/packagist/l/nicoSWD/php-rule-parser.svg)](https://packagist.org/packages/nicoswd/php-rules-parser)
186+
187+
[Master image]: https://travis-ci.org/nicoSWD/php-rule-parser.svg?branch=master
188+
[Master]: https://github.com/nicoSWD/php-rule-parser/tree/master
189+
[Master coverage image]: https://scrutinizer-ci.com/g/nicoSWD/php-rule-parser/badges/coverage.png?b=master
190+
[Master coverage]: https://scrutinizer-ci.com/g/nicoSWD/php-rule-parser/?branch=master
191+
[Master quality image]: https://img.shields.io/scrutinizer/g/nicoswd/php-rule-parser.svg?b=master
192+
[Master quality]: https://scrutinizer-ci.com/g/nicoSWD/php-rule-parser/?branch=master
193+
[0.3 image]: https://travis-ci.org/nicoSWD/php-rule-parser.svg?branch=v0.3
194+
[0.3]: https://github.com/nicoSWD/php-rule-parser/tree/v0.3
195+
[0.3 coverage image]: https://scrutinizer-ci.com/g/nicoSWD/php-rule-parser/badges/coverage.png?b=v0.3
196+
[0.3 coverage]: https://scrutinizer-ci.com/g/nicoSWD/php-rule-parser/?branch=v0.3
197+
[0.3 quality image]: https://img.shields.io/scrutinizer/g/nicoswd/php-rule-parser.svg?b=v0.3
198+
[0.3 quality]: https://scrutinizer-ci.com/g/nicoSWD/php-rule-parser/?branch=v0.3
199+
[Develop image]: https://travis-ci.org/nicoSWD/php-rule-parser.svg?branch=develop
200+
[Develop]: https://github.com/nicoSWD/php-rule-parser/tree/develop
201+
[Develop coverage image]: https://scrutinizer-ci.com/g/nicoSWD/php-rule-parser/badges/coverage.png?b=develop
202+
[Develop coverage]: https://scrutinizer-ci.com/g/nicoSWD/php-rule-parser/?branch=develop
203+
[Develop quality image]: https://img.shields.io/scrutinizer/g/nicoswd/php-rule-parser.svg?b=develop
204+
[Develop quality]: https://scrutinizer-ci.com/g/nicoSWD/php-rule-parser/?branch=develop

0 commit comments

Comments
 (0)