airbnb / synapse

A transparent service discovery framework for connecting an SOA
MIT License
2.07k stars 251 forks source link

Doc: README uses YAML config in Example Migration but only mentions JSON format in Configuration #324

Open dahutu opened 4 years ago

dahutu commented 4 years ago

Synapse can use both YAML and JSON format configuration files, and in Example Migration section of README.md, the example Synapse configuration is in YAML format. However Configuration section states "Synapse depends on a single config file in JSON format; it's usually called synapse.conf.json". This is not consistent with Synapse capability or the example config. Please fix by either change the example config file to JSON, or preferably, state that both JSON and YAML are valid for configuration.