Your documentation is misleading

[caligatio]

Your documentation is misleading

[Caligatio]

I have the version number in the CHANGELOG, bower.js, and package.json in
the master branch. Other than those three places (two of which explicitly
require versioning information), where else would you normally look for the
current version number?

On May 19, 2016 2:39 AM, "Alpha Shuro" [email protected] wrote:

Please indicate in your documentation that your master branch is version
2 of your library, it is terribly misleading and costs time to try and
figure out why it works differently from the usage I found in cordova's
twitter oauth plugin only to realize after looking at your branches that
you actually have a version 1 and version 2 😢

—
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub

[alphashuro]

That is fine, what I'm asking for is just an indication of the current version you are on, or even call the new one "v2" or something, anything at all, because I suspect when most people simpy need to hash something then will not specifically check the package.json or changelog but rather go straight from documentation to grabbing the file they need, which is why I'm asking the documentation specify version number as well..

[Caligatio]

You're saying to not use the master branch for the current code version and
instead do all current development in a v2 branch? Github defaults to the
master branch so you would have to look at all the available branches to
even notice.

I suppose I could put some note in the README but the API usage notes are
already in the README, which didn't appear to have helped you.
On May 19, 2016 5:36 AM, "Alpha Shuro" [email protected] wrote:

That is fine, what I'm asking for is just an indication of the current
version you are on, or even call the new one "v2" or something, anything at
all, because I suspect when most people simpy need to hash something then
will not specifically check the package.json or changelog but rather go
straight from documentation to grabbing the file they need, which is why
I'm asking the documentation specify version number as well..

—
You are receiving this because you commented.
Reply to this email directly or view it on GitHub
#44 (comment)

[Caligatio]

I'm open to ideas on this that don't involve moving development entirely into a non-master branch. Feel free to re-open if anything pops to mind.