Skip to content

Commit 31bc2a2

Browse files
authored
Update README.md
Update configuration instructions, omit references to the private alpha and add API documentation info.
1 parent 15cbd8a commit 31bc2a2

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -70,20 +70,16 @@ The language breakdown analysis tab also displays a table showing the Accepted P
7070

7171
4. **Total Active Copilot Chat Users:** a bar chart that illustrates the total number of users who have actively interacted with Copilot over the past 28 days.
7272

73-
## Requirements
74-
75-
Your organization must be enrolled in the GitHub Copilot API private alpha.
76-
7773
## Setup instructions
7874

79-
- Instructions on how to authenticate are provided in the API documentation - available if you have access to the private alpha.
75+
- Instructions on how to authenticate are provided in the [API documentation]([url](https://docs.github.com/en/enterprise-cloud@latest/rest/copilot/copilot-usage?apiVersion=2022-11-28))
8076

8177
### .env file setup
82-
- To utilize mocked data stored in a JSON file, simply set the following boolean environment variable to true:
78+
- To retrieve Copilot metrics via the API and display your organization's data, configure the following boolean environment variable to false:
8379
```
84-
VUE_APP_MOCKED_DATA=true
80+
VUE_APP_MOCKED_DATA=false
8581
```
86-
- To access Copilot metrics through the API, update your configuration by adding the following variables:
82+
- Additionally, update the following environment variables:
8783

8884
```
8985
VUE_APP_GITHUB_ORG=

0 commit comments

Comments
 (0)