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

Add some basic documentation #12

Closed
armanbilge opened this issue Sep 29, 2021 · 0 comments · Fixed by #29
Closed

Add some basic documentation #12

armanbilge opened this issue Sep 29, 2021 · 0 comments · Fixed by #29
Labels
documentation Improvements or additions to documentation

Comments

@armanbilge
Copy link
Member

Personally I think a small example in the README would be sufficient, demonstrating the FetchClient. Then just point to the http4s client docs or something.

Documenting the service-worker integration is a bit trickier. An example certainly wouldn't hurt, but to actually get a service worker running needs several moving parts. See https://developers.google.com/web/fundamentals/primers/service-workers.
@armanbilge armanbilge added the documentation Improvements or additions to documentation label Sep 29, 2021
@armanbilge armanbilge mentioned this issue Oct 24, 2021
Merged
@armanbilge armanbilge linked a pull request Oct 24, 2021 that will close this issue
Create docs #29
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Create docs armanbilge/http4s-dom
1 participant
@armanbilge