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

No example usages on README #1

Open
Th0ught09 opened this issue May 8, 2024 · 1 comment
Open

No example usages on README #1

Th0ught09 opened this issue May 8, 2024 · 1 comment

Comments

@Th0ught09
Copy link

The README does not indicate how this package should be used

@suzanneEmbury
Copy link
Contributor

I agree - it would be great to have two things:

  • instructions for playing with the package in the Python console - just connecting to a repo and pulling down some simple aspects - open issues or something?
  • a couple of simple code examples that show the package being used to pull information down from a repo.

I have some ideas for simple examples usages, but would love to hear your ideas, too @Th0ught09 .

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