Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Cyrille37 committed Apr 29, 2021
1 parent 0975292 commit 284e21e
Showing 1 changed file with 20 additions and 10 deletions.
30 changes: 20 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,37 @@
# yapafo - Yet Another Php Api For Ospenstreetmap
# Yet Another Php Api For OpenStreetMap

This library permits to read and write objects in the OpenStreetMap database.
**yapafo** is a library which permits to authenticate, read and write objects in the OpenStreetMap database.

## FEATURES
## FEATURES

- Read objects from API and Overpass-API.
- Read objects from API, XAPI and Overpass-API.
- Write objects to API.
- Authenticate with Basic or OAuth.
- The class instance and its osm objects is serializable.
- A bit of geometry stuff (id node inside/outside polygon)
- The class instance and its osm objects are serializable.
- A bit of geometry stuff (is node inside/outside polygon)
- ...

## REQUIREMENTS

Requirements are covered in `composer.json`.

Php extensions:

- [SimpleXml](https://www.php.net/manual/en/book.simplexml.php)

Php libraries:

- [psr/log](https://github.com/php-fig/log)
- [vlucas/phpdotenv](https://github.com/vlucas/phpdotenv)

## TUTORIALS / EXAMPLES

- look at tests/test_OSM_Api_with-network-write.php to see how to Read data, Authenticate and Save changes.
- A web page to create OAuth Access Token
- launch a browser at `examples-web/OAuthRequestAccess.php`
- like with `php -S localhost:8000`
- Other command-line examples in `examples-console`

### examples-web
### examples-web

- the tool examples/OAuthRequestAccess.php is an easy way to get OAuth Access Token (and understand the protocol phases ;-)
- Overpass-API requests are shown in examples/OApiQuery.php and ApiOApiQuery.php
Expand All @@ -33,6 +44,5 @@ Php extensions:

- The OAuth 1.0 Protocol : http://tools.ietf.org/html/rfc5849
- OSM OAuth doc : http://wiki.openstreetmap.org/wiki/OAuth

- [PSR-3: Logger Interface](https://www.php-fig.org/psr/psr-3/)
- [PSR-11: Container interface](https://www.php-fig.org/psr/psr-11/)

0 comments on commit 284e21e

Please sign in to comment.