Great work.
There's some simple files you can add to guide users as an open source project, Github has special files1 it uses to add info when using its client. A CONTRIBUTING would direct pull requests/issue guidelines, a LICENSE file would let Github fill in this and also be highly visible when the repo is cloned. An FAQ or contact page can also be added. Github provides some documentation describing what to consider when writing these https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors .
Great work.
There's some simple files you can add to guide users as an open source project, Github has special files1 it uses to add info when using its client. A CONTRIBUTING would direct pull requests/issue guidelines, a LICENSE file would let Github fill in this and also be highly visible when the repo is cloned. An FAQ or contact page can also be added. Github provides some documentation describing what to consider when writing these https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors .
Footnotes
Special files https://gist.github.com/jakebrinkmann/c63eaedbe384516e4a7bc133c1e1066b ↩