Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Better documentation #10

Open
10 tasks
augustohp opened this issue Nov 28, 2015 · 0 comments
Open
10 tasks

Better documentation #10

augustohp opened this issue Nov 28, 2015 · 0 comments
Labels
help wanted
Milestone
1.0

Comments

@augustohp
Copy link

We should have a documentation to end users on how to use the library. For that I think the most sensible approach is to have multiple markdown files inside a doc folder, we can use GitHub markdown rendering to use links exposed through a doc/README.md guiding the user through:

  • Describe terms used in the documentation:
    • What is a proxy factory.
    • What is a proxy.
    • What is a storage*.
    • What is an identity generator.
  • Using the library:
    • How to create and configure a proxy factory.
    • How to use a proxy.
  • Extending the library:
    • Create your own proxy interceptor.
    • Create your own identity generator.
  • Contributing.
  • Quickstart.
@augustohp augustohp added this to the 1.0 milestone Nov 28, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted
Projects
None yet
Milestone
1.0
Development

No branches or pull requests
1 participant
@augustohp