search

elixir-geolix / geolix

IP information lookup provider
Apache License 2.0
190 stars 18 forks source link

README.md Wrong #15

Closed mattludwigs closed 7 years ago

mattludwigs commented 7 years ago

In the README.md to download I used:

defp deps do
  [ { :geolix, "~> 0.10" } ]
end

And followed the documentation in the README I could not start the Database.Loader correctly. After exploring my deps and the current source code it seems that the README should work for the 0.11.0 code, whereas it does not work for ~> 0.10. Maybe updating the version should be the same version in the mix.exs file?

mneudert commented 7 years ago

You are probably looking for the README of the tag you are using (GitHub and HexDocs).

The dependency statement is valid for real releases and not the 0.11.0-dev only available via GitHub. Rest assured you are not the only one tripping over that :D

Could you think of some statement I could include to mention that difference? Might help to prevent the confusion...

mattludwigs commented 7 years ago

Yeah I was able to find the correct docs in the README found from the hex package under my deps directory, and from there everything worked great, so thanks for building a solid working package!

As far as including a statement, I am really bad at writing these types of things but maybe in include something along the lines of:

Documentation below is for the 0.11.0-dev release. Please see <insert some link or instructions here> for documentation for ~> 0.10 releases.

By the way, I am very excited about 0.11 after exploring the source code and docs for both versions! Cannot wait for the release, and thank you for working on this package!

mneudert commented 7 years ago

I tried to word it in a way that someone reading it on Hex is not confused and I don't have to modify it for upcoming versions. Should be good enough for now. And as a new release is around the corner the current problem will vanish for some time anyway :D