Skip to content

Commit

Permalink
feat(docs): Add custom source/layer documentation
Browse files Browse the repository at this point in the history
This ties into the new documentation for the API in
pelias/api#1297 for functionality originally
added in pelias/api#1131.

Fixes #36
Fixes #26
  • Loading branch information
orangejulius committed May 16, 2019
1 parent 2ec1146 commit 03d305e
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,11 @@ hash. A sample configuration file might look like:
}
]
},
"api": {
"targets": {
"yoursource": ["yourlayers"]
}
},
"logger": {
"level": "debug"
},
Expand All @@ -180,6 +185,19 @@ hash. A sample configuration file might look like:
}
```

**Important:** You must put any custom source and layers imported by your data in `pelias.json as explained in the relevant [API configuration documentation](https://github.com/pelias/api#custom-sources-and-layers). For a reasonably common use case for the source `csv` with only records in the `address` layer, the following configuration is a good starting point:


```
{
"api": {
"targets": {
"csv": ["address"]
}
}
}
```

The following properties are recognized:

This importer is configured using the [`pelias-config`](https://github.com/pelias/config) module.
Expand Down

0 comments on commit 03d305e

Please sign in to comment.