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.

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

Documentation #53

Closed
rilwis opened this issue Jul 28, 2018 · 2 comments · Fixed by #54
Closed

Documentation #53

rilwis opened this issue Jul 28, 2018 · 2 comments · Fixed by #54

Comments

@rilwis
Copy link

rilwis commented Jul 28, 2018

I really like this library as it's small and fast. While it's not popular as Zend Diactoros or Guzzle, it strictly follows the PSR standards, which I really appreciate.

However, one thing that makes me wondering from use it or not is the documentation. There's nothing, even a "hello world" example. Other libraries do have. So, I'd suggest adding some basic usage in the README to let developers how to use it.

Thanks

@Nyholm
Copy link
Owner

Nyholm commented Jul 28, 2018

That is a great idea. Thank you.

Could you give me 4-5 "questions" that you would like the documentation to answer?

@rilwis
Copy link
Author

rilwis commented Jul 28, 2018

No problem. I think these are the most basic things:

  • Installation
  • Getting Started / Basic Usage
  • Public methods for each objects (perhaps this repeats from PSR, but still worth mentioning)
  • Integration with your app/framework

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

Successfully merging a pull request may close this issue.

2 participants