|
1 |
| - |
2 |
| - |
| 1 | +_NOTE: For information on support and assistance, click [here](https://github.com/github-copilot-resources/copilot-metrics-viewer/tree/main?tab=readme-ov-file#support)._ |
3 | 2 |
|
4 | 3 | # GitHub Copilot Metrics Viewer
|
5 | 4 | <p align="center">
|
6 | 5 | <img width="150" alt="image" src="https://github.com/github-copilot-resources/copilot-metrics-viewer/assets/3329307/8473a694-217e-4aa2-a3c7-2222a321c336">
|
7 | 6 | </p>
|
8 |
| -This application displays a set of charts with various metrics related to GitHub Copilot for your <i>GitHub Organization</i>. These visualizations are designed to provide clear representations of the data, making it easy to understand and analyze the impact and adoption of GitHub Copilot. |
| 7 | + |
| 8 | +This application displays a set of charts with various metrics related to GitHub Copilot for your <i>GitHub Organization</i> or <i>Enterprise Account</i>. These visualizations are designed to provide clear representations of the data, making it easy to understand and analyze the impact and adoption of GitHub Copilot. This app utilizes the [GitHub Copilot Metrics API](https://docs.github.com/en/enterprise-cloud@latest/rest/copilot/copilot-usage?apiVersion=2022-11-28). |
9 | 9 |
|
10 | 10 | ## Video
|
11 | 11 |
|
@@ -72,8 +72,6 @@ The language breakdown analysis tab also displays a table showing the Accepted P
|
72 | 72 |
|
73 | 73 | ## Setup instructions
|
74 | 74 |
|
75 |
| -Instructions on how to authenticate are provided in the [API documentation](https://docs.github.com/en/enterprise-cloud@latest/rest/copilot/copilot-usage?apiVersion=2022-11-28) |
76 |
| - |
77 | 75 | In the `.env` file, you can configure several environment variables that control the behavior of the application.
|
78 | 76 |
|
79 | 77 | #### VUE_APP_SCOPE
|
@@ -128,19 +126,21 @@ docker build -t copilot-metrics-viewer .
|
128 | 126 | ```
|
129 | 127 | docker run -p 8080:80 copilot-metrics-viewer
|
130 | 128 | ```
|
131 |
| -The application is accessible at http://localhost:8080 |
| 129 | +The application will be accessible at http://localhost:8080 |
132 | 130 |
|
133 | 131 | ## License
|
134 | 132 |
|
135 | 133 | This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE.txt) for the full terms.
|
136 | 134 |
|
137 | 135 | ## Maintainers
|
138 | 136 |
|
139 |
| -@martedesco |
| 137 | +[@martedesco](https://github.com/martedesco) |
140 | 138 |
|
141 | 139 | ## Support
|
142 | 140 |
|
143 |
| -I aim to provide support through GitHub Issues. While I strive to stay responsive, I can't guarantee immediate responses. For critical issues, please include "CRITICAL" in the title for quicker attention. |
| 141 | +This project is independently developed and maintained, and is not an official GitHub product. It thrives through the dedicated efforts of myself ([@martedesco](https://github.com/martedesco)) and our wonderful contributors. A heartfelt thanks to all our contributors! ✨ |
| 142 | + |
| 143 | +I aim to provide support through [GitHub Issues](https://github.com/github-copilot-resources/copilot-metrics-viewer/issues). While I strive to stay responsive, I can't guarantee immediate responses. For critical issues, please include "CRITICAL" in the title for quicker attention. 🙏🏼 |
144 | 144 |
|
145 | 145 | ### Coming next 🔮
|
146 | 146 | - Team slicing
|
|
0 commit comments