Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): Add custom source/layer documentation #37

Merged
merged 1 commit into from
May 19, 2019
Merged

feat(docs): Add custom source/layer documentation #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
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