diff --git a/README.md b/README.md index 566a3ea..916fe57 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ jobs: uses: actions/checkout@v3 - name: AI Code Reviewer - uses: your-username/ai-code-reviewer@main + uses: freeedcom/ai-codereviewer@main with: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # The GITHUB_TOKEN is there by default so you just need to keep it like it is and not necessarily need to add it as secret as it will throw an error. [More Details](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret) OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }} @@ -46,8 +46,7 @@ jobs: exclude: "**/*.json, **/*.md" # Optional: exclude patterns separated by commas ``` -4. Replace `your-username` with your GitHub username or organization name where the AI Code Reviewer repository is - located. +4. (Optional) Fork this repository to your account or organization then replace `freeedcom/ai-codereviewer` with the name of the forked repository. For example, if you forked the repository to `MyUsername/ai-code-reviewer`, then you would change this line to `uses: MyUsername/ai-code-reviewer@main`. 5. Customize the `exclude` input if you want to ignore certain file patterns from being reviewed.