simple_token_authentication icon indicating copy to clipboard operation
simple_token_authentication copied to clipboard

Q: There are quite a lot of options now, could the README be made clearer?

Open gonzalo-bulnes opened this issue 8 years ago • 1 comments

When I have a specific token authentication scenario in mind And I wonder if Simple Token Authentication is the right tool for the job I want to get a quick understanding of how it works And what token authentication scenarios are easy to implement So that I can make a decision before I read through the implementation details

See the new documentation drafts below! : )

gonzalo-bulnes avatar Sep 24 '16 02:09 gonzalo-bulnes

So, from the issues that have been opened in the past few months, I believe the first thing that is missing in the current version of the README is an overview of how the gem works.

I also believe most of the configuration would rather live in the wiki or in separate documents, so that the README itself is a bit shorter, or more detailed within the current length. (Any thoughts about storing the configuration examples in the wiki vs the doc/ directory? Please post a comment below!)

Work in progress to address the first issue can be found in this draft README. Feedback would be more than welcome.

gonzalo-bulnes avatar Sep 24 '16 02:09 gonzalo-bulnes