README doesn't explain what gren does about github-release-notes

[broofa]

Found https://github-tools.github.io/github-release-notes/examples after a bit of hunting around.

1. The way the action param is documented could be clearer. IMHO, the first thing in the readme should be a Usage section with gren [--action=[release|changelog] ... style notation. Then document each param, what it does, and provide an example below that. (My $.02)

2. The animated gifs aren't very helpful. Would prefer simple copy/paste of console log for examples. Easier to follow.

[Edit: Part of the problem with the gifs is that you only see the last few lines of output - the most interesting part, generally - for a split second before it starts over. Frustrating.]

Other than that, thanks for a cool tool!

[broofa]

Oh... and look, apparently gren documented the release under my project's "releases" tab. That's really cool... yet not at all obvious that's what's happening. (And, yes, maybe I should have surmised this was what was going to happen based on the name, but I was expecting it to generate a RELEASE_NOTES.md file or something like that.)

[dddom]

I suppose it's worth mentioning I think it’d be great if the first thing you read was about the philosophy of this tool, that it’s GITHUB RELEASE NOTES, how you should use GitHub to create the right content for this tool to use, what would be the steps or workflow, philosophy I’d need to adapt to be able to use this tool effectively, what benefits would that bring etc.

@broofa has a point about the gifs, I don’t find them useful either, because it’s not useful to see the process of printing the log and have it disappear immediately. Console output would be better in this case, if not even just concise screenshots (syntax highlighting is useful).

[alexcanessa]

@broofa, @dddom good points.

I always had the impression that either the README.md or the documentation, in general, were clear enough.

Thanks for your feedback, definitely going to address it.

[broofa]

If I had a nickel for every time I thought my docs were obvious, only to be proven horribly wrong... :-)

Thanks for your patience with this noob.

[alexcanessa]

@broofa the new README.md and documentation should fix this issue.

Closed by #85