diff --git a/README.md b/README.md index 0370006..8a418fb 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,9 @@ ENABLE_PUSH_CREATE_ORG = true Optionally, create a new organization in your Gitea instance to store your `ggv` vendor repos. +> [!WARNING] +>It is recommended to create a user that only has access to that one organization and use said new user to generate the below API key. + Create a new API key under `User -> Settings -> Applications -> Generate New Token`. This key needs `repository` "Read and Write" access. Everything else can be left to "No Access". @@ -21,5 +24,5 @@ This key needs `repository` "Read and Write" access. Everything else can be left I recommend setting up a chron job or some form of automation for this. My deployment involves running this on my Gitea mirror (this server mirrors my main Gitea instance as well as my GitHub) weekly using a chron job, then my main Gitea instance mirrors the output repos from this tool. -[!WARNING] -This tool assumes your default branch is what you want to vendor. +> [!WARNING] +>This tool assumes your default branch is what you want to vendor.