Update README with version information #40
Conversation
Add current expected version and link to current stable release.
|
ping. Anyone have thoughts on this? |
|
Should it better to just say current version in master? |
|
@samnang, I'm not exactly sure what you mean. The problem that I have seen is when someone is using the gem and then viewing the README on GitHub as the reference. If they have a previous stable version installed but the master branch has deviated then there really isn't anything telling them that. This simple addition to the README solves the problem right up front. If you're suggesting that we just put the current version in the README, I say, that's fine, just that this is a little friendlier. Either way, indicating the version in the README is a good idea. Does that help answer your question at all? |
@elskwid what I mean is that instead of putting a next release version in README, we could just say in the README it is for master branch. |
|
@samnang: Sure I guess, but it isn't that people forget that they're looking at master, it's making the version a first-class concern of the documentation. |
|
...I suppose a note saying "if you expect |
|
So, I don't want to have to remember to update the README every time I push a gem version. Because I won't. If someone wants to figure out how to tack a task onto the |
Add current expected version and link to current stable release.
This is almost verbatim from grape and I find it a huge benefit for a simple change. It addresses issues like #39 where someone is viewing documentation for master and trying to use the features on a release version.
It does have the drawback that the release process needs to take it into account.