Skip to content
This repository has been archived by the owner on May 16, 2021. It is now read-only.

Add documentation #55

Closed
m-o-e opened this issue May 2, 2013 · 3 comments
Closed

Add documentation #55

m-o-e opened this issue May 2, 2013 · 3 comments

Comments

@m-o-e
Copy link

m-o-e commented May 2, 2013

Please

  • Explain how each protection works and the corner cases
  • Explain how to correctly implement each protection in a Rack/Sinatra app
  • Explain how to test each protection in a live app (to ensure they are properly enabled)
@m-o-e m-o-e closed this as completed May 2, 2013
@rkh rkh reopened this May 2, 2013
@m-o-e
Copy link
Author

m-o-e commented May 2, 2013

Ha! ;)

To clarify what was going on: I closed my request after realizing that the code is actually quite well-documented and easy to follow. Thus personally I don't need the docs anymore, but I still think new users would benefit from some guidance. Especially with regard to the critical protections that are disabled by default (CSRF!), which is imho not obvious from the current README.

@rkh
Copy link
Member

rkh commented May 2, 2013

There are CSRF protections that are not disabled by default. We need to make docs more accessible and actually give more examples.

@zzak
Copy link
Member

zzak commented Jul 28, 2016

I would agree there is serious lack of examples, but the docs should be accessible now as of closing #161.

I'll close this now and open up a new ticket upstream to explain the situation -- which hopefully will gain more traction than this repo.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants