add readme

This commit is contained in:
Maximilian Ruta 2019-06-25 15:27:51 +02:00
parent 48d33c3011
commit 3c9adde39c

18
README.md Normal file
View file

@ -0,0 +1,18 @@
Green Directory PHP [![Build Status](https://travis-ci.org/netzbegruenung/green-directory-php.svg?branch=master)](https://travis-ci.org/netzbegruenung/green-directory-php)
============
PHP reader for [green-directory](https://github.com/netzbegruenung/green-directory) data.
## Example
```php
<?php
use Netzbegruenung\GreenDirectory\Reader;
use Netzbegruenung\GreenDirectory\Repository;
$repository = new Repository(new Reader(__DIR__ . '/green-directory/data'));
$chapter = $repository->findBySherpaId('11002609');
echo $chapter->getCity();
```