Skip to content

Commit 6361e5b

Browse files
committed
README.md updated
1 parent 7a9d864 commit 6361e5b

File tree

2 files changed

+32
-3
lines changed

2 files changed

+32
-3
lines changed

README.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,31 @@
1-
# scim-filter-parser
2-
SCIM filter parser
1+
# SCIM filter parser
2+
3+
The PHP parser for SCIM filter. SCIM stands for System for Cross-domain Identity Management and more details can be
4+
found on http://www.simplecloud.info/ website.
5+
6+
[![Author](http://img.shields.io/badge/author-@tmilos-blue.svg?style=flat-square)](https://twitter.com/tmilos77)
7+
[![Build Status](https://travis-ci.org/tmilos/scim-filrer-parser.svg?branch=master)](https://travis-ci.org/tmilos/scim-filrer-parser)
8+
[![Coverage Status](https://coveralls.io/repos/github/tmilos/scim-filrer-parser/badge.svg?branch=master)](https://coveralls.io/github/tmilos/scim-filrer-parser?branch=master)
9+
[![License](https://img.shields.io/packagist/l/tmilos/scim-filrer-parser.svg)](https://packagist.org/packages/tmilos/scim-filrer-parser)
10+
11+
12+
# Usage
13+
14+
```php
15+
<?php
16+
$parser = new Parser();
17+
$node = $parser->parse('userType eq "Employee" and (emails co "example.com" or emails.value co "example.org")');
18+
/*
19+
walk the node...
20+
Conjunction = {
21+
ComparisonExpression => userType eq Employee
22+
Disjunction => {
23+
ComparisonExpression => emails co example.com
24+
ComparisonExpression => emails.value co example.org
25+
}
26+
}
27+
*/
28+
```
29+
30+
For more details look at the [unit tests](tests/ParserTest.php).
31+

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "tmilos/scim-filter-parser",
33
"description": "SCIM AST filter parser library",
4-
"keywords": ["SCIM", "AST", "parser", "SCIM parser", "SCIM filter parser", "SCIM AST"],
4+
"keywords": ["SCIM", "AST", "parser", "SCIM parser", "SCIM filter parser", "SCIM AST", "simplecloud"],
55
"license": "MIT",
66
"authors": [
77
{

0 commit comments

Comments
 (0)