diff --git a/README.md b/README.md index 4eddbe6..aad74cc 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,13 @@ -1- Add a secret for actions on your github repository with your Telnyx Token at TELNYXAI_TOKEN +# Getting Started -2- Create the following file on your repository `.github/workflows/review_pr.yml` +To get started visit [Telnyx Inference documentation](https://developers.telnyx.com/docs/inference/getting-started) -``` +# How to add it to my project? + +1. [Add a secret for actions on your github repository](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions) with your Telnyx Token at TELNYXAI_TOKEN +1. Create the following file on your repository `.github/workflows/review_pr.yml` + +```yaml name: PR Review on: @@ -24,4 +29,4 @@ jobs: model_name: 'meta-llama/Meta-Llama-3.1-8B-Instruct' ``` -Done , The next time a PR is open it will be automatically reviewed by Telnyx Inference. +And done , The next time a PR is open it will be automatically reviewed by Telnyx Inference.