No example usages on README

robota-suite / robota-core

A Python package for reading in elements of GitLab and GitHub repositories, for further analysis.

https://robota-core.readthedocs.io

MIT License

0 stars 9 forks source link

Open Th0ught09 opened 4 months ago

Th0ught09 commented 4 months ago

The README does not indicate how this package should be used

suzanneEmbury commented 4 months ago

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 .