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

Add guide and samples for getting started #46

Open
karashiiro opened this issue Aug 13, 2023 · 0 comments
Open

Add guide and samples for getting started #46

karashiiro opened this issue Aug 13, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@karashiiro
Copy link
Collaborator

Currently, guide-level documentation only exists for specialized features like request/response transformers. For basic usage, the README suggests looking at n0madic's repo, since the Scraper interface is nearly the same.

That decision was mostly made out of laziness — real guide-level documentation should be written, and there should be working examples beyond unit tests, especially for common runtime environments where developers are expected to want to use this library (Node/browser/edge runtimes).

@karashiiro karashiiro added the documentation Improvements or additions to documentation label Aug 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant