diff --git a/README.md b/README.md index 785e77f..e90cf63 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,12 @@ -# Prerequisites +# What is this? + +This is the code for a [Gitea Action](https://docs.gitea.com/usage/actions/overview) that can be used to generate [GitHub Contribution History](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile) based on the commits you have made to the the source repo. + +![GitHub Contribution Graph](./img/contribution-graph.webp "Gotta make it green!") + +# Onboarding + +## Prerequisites * **Repos must use `main` as the default branch.** Come on, it's been like 5 years. * ...ok _fine_ I will consider adding customization for this. But not a priority to begin with. @@ -14,6 +22,10 @@ Not a prerequisite, but a practicality note - I _think_ this will has a runtime[ If a target-repo gets so unreasonably large that even the runtime of syncing it from a single commit is too high, then I guess you could trigger writing to different target repos from each source repo in some hash-identified way - but, as I've said many times already in this project, YAGNI :P +## Usage + +TODO - provide example `.gitea/workflows/` file here showing usage (you can look at the self-triggering example in this repo's own directory, but we could do better by using the context variables and an external secrets store) + # FAQs ## Why not just use Gitea's existing mirroring functionality? diff --git a/img/contribution-graph.webp b/img/contribution-graph.webp new file mode 100644 index 0000000..10b4d4f Binary files /dev/null and b/img/contribution-graph.webp differ