Skip to content

Commit 6c1f85e

Browse files
committed
Add "what's this" blurb
1 parent 71e5ef6 commit 6c1f85e

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# featureService #
22

3+
## What's this? ##
4+
5+
The featureService is a simple JSON REST API that enables you to work with the
6+
[OpenStreetMap](https://www.openstreetmap.org/) data-set.
7+
8+
Using the featureService you can, for example, discover all the locations or
9+
points of interest in a particular area or look up properties of locations such
10+
as their bounding box, centroid or name.
11+
312
## Setup ##
413

514
### System dependencies ###
@@ -64,6 +73,8 @@ your Postgres on Azure instance is getting populated with over 2GB of global
6473
geo-spatial features and appropriate indices are being built. On subsequent
6574
runs, the start should be instantaneous.
6675

76+
### Using the application ##
77+
6778
After starting the service, you will be able to call the featureService, for
6879
example via the following requests:
6980

0 commit comments

Comments
 (0)