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

Initialize README with how-to-use #3

Open
jeffreyliu opened this issue Jun 20, 2017 · 1 comment
Open

Initialize README with how-to-use #3

jeffreyliu opened this issue Jun 20, 2017 · 1 comment

Comments

@jeffreyliu
Copy link
Member

Create documentation about the functions and how to use the templates

Should cover:

  1. how to import package
  2. required functions and structure for a scraper
  3. the scope and interface of the scraper (what it should get, where should it write to)
  4. the functions available in the template
@titaniumbones
Copy link

@jeffreyliu am I right that this templates gathers URL info but does not actually capture the body of the http response? And if I'm right, will the body be captured by sentry, or by some other entity? And finally, whether my guess is right or wrong, could this readme also include the answers to these questions (so it's very clear to new contributors)?

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

No branches or pull requests

2 participants