Skip to content

Commit

Permalink
Update package name, readme, and example server.
Browse files Browse the repository at this point in the history
  • Loading branch information
rgwozdz committed Dec 27, 2018
1 parent 675406c commit 730685d
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 2 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,30 @@ Serve local GeoJSON files as [Koop](https://github.com/koopjs/koop) services. U

## Getting Started

Add the provider to your koop instance

``sh
$ npm install @koopjs/provider-file-geojson
``

Then register the provider with Koop in your server file.

``js
const Koop = require('koop')
const koop = new Koop()

const provider = require('@koopjs/provider-file-geojson')
koop.register(provider)
``

### Example server
The repository includes its own `server.js` that will start a Koop instance and register the file-geojson provider. To start serving:

```sh
git clone https://github.com/koopjs/koop-provider-file-geojson

cd koop-provider-file-geojson

$ npm install

$ npm start
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "koop-provider-file-geojson",
"name": "@koopjs/provider-file-geojson",
"version": "1.0.0",
"description": "Simple provider for serving file-based GeoJSON",
"main": "dist/index.js",
Expand Down
2 changes: 1 addition & 1 deletion server.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ const koop = new Koop()

const config = require('config')

const provider = require('./index.js')
const provider = require('@koopjs/provider-file-geojson')
koop.register(provider)

// Set port for configuration or fall back to default
Expand Down

0 comments on commit 730685d

Please sign in to comment.