search

pelias / pelias

Pelias is a modular open-source geocoder using Elasticsearch.
https://pelias.io
MIT License
3.2k stars 221 forks source link

Consider adding usage sample in readme #886

Open matkoniecz opened 4 years ago

matkoniecz commented 4 years ago

Consider adding more prominent usage sample in readme

Use-cases

I am trying to understand whatever Pelias would be a good tool for me (small scale use, single person).

I am also trying to find how communication with server setup by Pelias is happening - via nodeJS library? via REST api? via CLI commands?

Attempted Solutions

I have read through README. On second read (during creating this issue) I found https://github.com/pelias/pelias/blob/master/README.md#documentation

Proposal

Add specific usage example at https://github.com/pelias/pelias#whats-a-geocoder-do-anyway with command shown and output hidden. Replace search.mapzen.com with something like server_address.example.com

References

matkoniecz commented 4 years ago

Note: I am likely to make a PR if that proposal would be considered as an improvement.

missinglink commented 4 years ago

Hi @matkoniecz I don't understand what you mean by "how communication with setup server is happening", what do you mean when you say "setup server"?

matkoniecz commented 4 years ago

Changed to

I am also trying to find how communication with server setup by Pelias is happening

Hopefully it turns my Engrish into something readable

orangejulius commented 4 years ago

Hi @matkoniecz,

Yes, there is a full JSON response hidden deep in the README and I agree with you that it's a little too hidden, so thanks for bringing that up. If you wanted to open a PR to do something like move the curl command out of the "hidden" part of the <details> block, that might be a great improvement. Let us know if you have any other ideas.