Julian Simioni
87923148e7
feat(doc): Point to common requirements doc
...
This will prevent us from having to update supported Node.js versions in
many places for each release
6 years ago
Julian Simioni
d1dfbf2dcb
Add Configurable Boosts readme section
6 years ago
Julian Simioni
b037835b04
Reorder config options roughly by importance
6 years ago
Julian Simioni
0deb24b51e
Fix typo
6 years ago
Julian Simioni
39f144c5a0
Add environment variable configuration section
...
Previously, we were conflating environment variable and `pelias.json`
configuration options, and omitted the port option completely.
Add a new section which clearly explains the two environment variables
that affect Pelias API operation.
6 years ago
Julian Simioni
6295d027b4
Fix README typo
6 years ago
Julian Simioni
47f3f87e72
Fix README formatting
6 years ago
Julian Simioni
192ffc13dd
feat(docs): Add examples of using service `timeout` and `retry` settings
...
These examples have been possible from the beginning, but not explicitly
called out in documentation.
Fixes https://github.com/pelias/wof-admin-lookup/issues/192
6 years ago
Julian Simioni
b9353ef64d
Add `attributionURL` parameter to configuration documentation
...
This should have been added in #1149
6 years ago
missinglink
83ab1636e1
readme: documentation for api.targets config
7 years ago
Julian Simioni
0785f28a64
Remove default focus point from example config
...
I predict this would have caused weird query issues for people who
copied it
7 years ago
Julian Simioni
f8771ca6f8
Update Node.js versions in README
7 years ago
Julian Simioni
0a1b34aea5
Add note that there are services besides Elasticsearch
7 years ago
Julian Simioni
66e21b4d23
Update example pelias.json
7 years ago
Julian Simioni
8ac8adb819
Fix grammar
7 years ago
Julian Simioni
04a3ae84db
Update list of services with libpostal
7 years ago
Julian Simioni
5ace10adc6
Update README header
...
We should probably propagate this change to all READMEs.
7 years ago
Stephen Hess
0a95dd2583
removed references to `textAnalyzer` config setting
7 years ago
Stephen Hess
95551abb9d
updated for new location of interpolation service
7 years ago
Lily He
a66df9bbdc
location bias description in README
7 years ago
Lily He
f019f0ab5e
deletd legacy routes and legacyURL code
7 years ago
Stephen Hess
ff39600de6
removed new
8 years ago
Stephen Hess
b33ad6c7ae
updated README for pip/placeholder configuration
8 years ago
Julian Simioni
719badf43d
Fix table formatting
...
It looks like markdown tables don't allow for newlines, so the changes
in https://github.com/pelias/api/pull/883 break the table.
8 years ago
Diana Shkolnikov
a660d7e72f
textAnalyzer not required
8 years ago
Diana Shkolnikov
a5370e0738
add an example
8 years ago
Diana Shkolnikov
1a8fe30a56
Add config details
8 years ago
Stephen Hess
21e8130041
added note about npm run config
8 years ago
Diana Shkolnikov
cda31a1b6f
npm badge
8 years ago
Diana Shkolnikov
92c3c67915
add ci, versioning, and npm badge
8 years ago
greenkeeper[bot]
b7c175b3eb
docs(readme): add Greenkeeper badge
...
https://greenkeeper.io/
8 years ago
Julian Simioni
11c3388b57
Add readme note about Node 4
8 years ago
Julian Simioni
6cde730e49
fix: URL for Gitter does not appear correctly on NPM
8 years ago
Julian Simioni
c691df2f60
Reorganize Readme header
...
This moves things around to be a bit more organized:
* Puts our standard header with links to pelias/pelias, Mapzen Search,
etc first
* moves the badges together
* The link to the documentation was going to a silly page that just
linked to another page, so it's a direct link now.
* Adds a small description sentence
9 years ago
Peter Johnson
63558eb15d
add ciao dummy data script and README on how to use it
9 years ago
Peter Johnson
687c26555f
installing pelias/scripts no longer required
9 years ago
Diana Shkolnikov
c21494ef44
Fix broken link to DOCS
9 years ago
Severyn Kozak
bd2c65a798
Document the pelias-config accessLog option.
...
README.md
-Add a section documenting all of the pelias-config options
recognized by the API.
-Document the `accessLog` option.
10 years ago
Severyn Kozak
1ce9f1bb05
Shotgun edits to the README.
...
README.md
-Edit a bunch of unrelated things... sorry. ;)
-Condense the documentation of different `npm run`nable commands
to one list.
-Remove the note about Travis, since that applies to virtually
all the Pelias repos and is documented elsewhere.
-Point the API docs hyperlink to `DOCS.md`.
10 years ago
Diana Shkolnikov
0d07c38b06
add to README
10 years ago
Diana Shkolnikov
5101d802ab
remove code-climate hooks
10 years ago
Diana Shkolnikov
7b5a2fafb9
Change query to use `terms` and add code coverage stats
10 years ago
Harish Krishna
b8ede3680e
adding script dependency
10 years ago
The Gitter Badger
222344e74f
Added Gitter badge
10 years ago
Peter Johnson
75d2eabbbe
readme
10 years ago
Peter Johnson
004ad6f5f7
readme
10 years ago
Peter Johnson
d3cf952324
readme
10 years ago