search

vdaubry / github-awards

Discover your ranking on github :
http://git-awards.com
MIT License
1.58k stars 122 forks source link

Adding documentation #91

Closed nunogoncalves closed 8 years ago

nunogoncalves commented 8 years ago

This PR adds documentation to the api. There's something I think we should do:

In the config/initializers/swagger_docs.rb file there's a line that is hard coded to the base path.

:base_path => "http://github-awards.com/",

I think it would be more prudent to have an env variable to set it. For example to distinguish dev envs and production.

Try this out on your local env too. The documentation page should be able to make proper calls. :)

vdaubry commented 8 years ago

Absolutely, i added an env var for the current HOST.