Adds README information

README.md

@@ -1 +1,17 @@
-# github-mirroring
+# GitHub mirroring to forgejo.dev
+
+Configuration needed:
+- The repository must be enabled in Woodpecker-CI.
+- The repository must have set the `trusted` flag in Woodpecker-CI.
+    - Therefore, the user must be added to the Woodpecker-CI admins.
+- Secrets:
+    - `GITHUB_TOKEN` = Personal access token for GitHub
+    - `GITEAL_URL` = The URL of the Gitea instance
+    - `ACCESS_TOKEN` = Access token of the Gitea instance
+    - `DOCKER_PASSWORD` = User password or access token for the Gitea instance to access the registry
+
+
+## License
+
+This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for more details.
+