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 #229

Open
reefebba opened this issue Feb 25, 2019 · 5 comments
Open

Documentation #229

reefebba opened this issue Feb 25, 2019 · 5 comments
Assignees
Labels

Comments

@reefebba
Copy link

It would be very nice of this package if it has more beginner-friendly and all-covered documentation with examples.
However, Thank you, this package is very helpful

@neomerx neomerx self-assigned this Feb 25, 2019
@neomerx
Copy link
Owner

neomerx commented Feb 25, 2019

@reefebba Hi, there is a wiki which is intended to provide such information and sample aplication that demonstrate how to work with the library. Also, there is a ton of tests that demonstrate every single aspect of the lib usage (mind you 100% test coverage).

If you haven't seen them, please have a look and drop a few lines with feedback. Is it enough? How easy it understandable for a new user? Do you see any changes that could make it better? Don't hesitate to send a PR or ask a question.

@JustSteveKing
Copy link

The examples and documentation provided show a very nice and easy way to use this package, but more indepth API docs could be useful to know what the constrains of the package are. I can kind of dig around and figure it out - but not all developers are going to be comfortable doing this

Repository owner deleted a comment from nebur81 Apr 4, 2019
Repository owner deleted a comment from nebur81 Apr 4, 2019
@Doqnach
Copy link

Doqnach commented Aug 21, 2019

Would love to see some documentation on how to handle a POST/PUT/PATCH with a (new) resource and one with a collection of (new) resources.

@neomerx
Copy link
Owner

neomerx commented Aug 22, 2019

@Doqnach Handling HTTP is out of the project's scope. You can use any framework of your choice to handle HTTP and use the library to encode your models/resources into JSON.

@Doqnach

This comment has been minimized.

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

No branches or pull requests

4 participants