Skip to content

Commit 8d31398

Browse files
authored
Update README.md
1 parent 3de69c7 commit 8d31398

File tree

1 file changed

+33
-6
lines changed

1 file changed

+33
-6
lines changed

README.md

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,52 @@
44

55
## Charts and Data Visualizations
66

7-
This includes a set of charts that visualize various metrics related to GitHub Copilot. These visualizations are designed to provide clear representations of the data, making it easy to understand and analyze the impact and usage of GitHub Copilot. Here are the key metrics visualized in these charts:
7+
This includes a set of charts that visualize various metrics related to GitHub Copilot for your organization. These visualizations are designed to provide clear representations of the data, making it easy to understand and analyze the impact and usage of GitHub Copilot. Here are the key metrics visualized in these charts:
88

99
### Key Metrics
1010

1111
1. **Total Suggestions:** This chart illustrates the total number of code suggestions made by GitHub Copilot. It offers a view of the tool's activity and its engagement with users over time.
1212

1313
2. **Total Acceptances:** This visualization focuses on the total number of suggestions accepted by users. This metric is crucial to understand the effectiveness and accuracy of GitHub Copilot's suggestions.
1414

15-
3. **Total Lines Suggested:** A detailed chart showcasing the total number of lines of code suggested by GitHub Copilot. This gives an idea of the volume of code generation and assistance provided.
15+
<p align="center">
16+
<img width="600" alt="image" src="https://github.com/martedesco/copilot-metrics-viewer/assets/3329307/b3b8ce00-26e1-424e-9bd6-000f2245ad6b">
17+
</p>
18+
19+
4. **Total Lines Suggested:** A detailed chart showcasing the total number of lines of code suggested by GitHub Copilot. This gives an idea of the volume of code generation and assistance provided.
20+
21+
5. **Total Lines Accepted:** This chart compares the total lines of code accepted by users, offering insights into how much of the suggested code is actually being utilized in real-world applications.
22+
<p align="center">
23+
<img width="600" alt="image" src="https://github.com/martedesco/copilot-metrics-viewer/assets/3329307/8c63920e-35e7-4a09-a7bc-2df2f5f03492">
24+
</p>
25+
26+
6. **Total Active Users:** An interactive graph representing the number of active users engaging with GitHub Copilot. This helps in understanding the tool's popularity and user base growth.
27+
28+
<p align="center">
29+
<img width="600" alt="image" src="https://github.com/martedesco/copilot-metrics-viewer/assets/3329307/879d627c-0267-456e-b456-a583d1ca368a">
30+
</p>
1631

17-
4. **Total Lines Accepted:** This chart compares the total lines of code accepted by users, offering insights into how much of the suggested code is actually being utilized in real-world applications.
1832

19-
5. **Total Active Users:** An interactive graph representing the number of active users engaging with GitHub Copilot. This helps in understanding the tool's popularity and user base growth.
2033

2134
### Breakdown Analysis
2235

2336
_Coming soon_
2437

38+
## Requirements
39+
40+
Your organization must be enrolled in the [GitHub Copilot API private alpha]([url](https://docs.github.com/en/early-access/copilot/copilot-usage-api)).
41+
2542
## Project setup
43+
44+
Edit the .env file in the root directory of the project and add the following variables:
45+
46+
```
47+
VUE_APP_GITHUB_ORG=
48+
VUE_APP_GITHUB_TOKEN=
49+
```
50+
51+
52+
## Running
2653
```
2754
npm install
2855
```
@@ -42,5 +69,5 @@ npm run build
4269
npm run lint
4370
```
4471

45-
### Customize configuration
46-
See [Configuration Reference](https://cli.vuejs.org/config/).
72+
### Coming soon 🔮
73+
Enterprise level charts

0 commit comments

Comments
 (0)