Skip to content

Commit 84b651b

Browse files
committed
Add detailed sections to README and include LICENSE file
1 parent 47b50f0 commit 84b651b

2 files changed

Lines changed: 41 additions & 0 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Bruno Borges and the Copilot Community SDK contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,18 @@ Java SDK for programmatic control of GitHub Copilot CLI.
99

1010
> **Note:** This SDK may change in breaking ways.
1111
12+
## Table of Contents
13+
14+
- [Requirements](#requirements)
15+
- [Installation](#installation)
16+
- [Quick Start](#quick-start)
17+
- [Try it with JBang](#try-it-with-jbang)
18+
- [Documentation](#documentation)
19+
- [Building and Testing](#building-and-testing)
20+
- [Projects Using This SDK](#projects-using-this-sdk)
21+
- [Contributing](#contributing)
22+
- [License](#license)
23+
1224
## Requirements
1325

1426
- Java 17 or later
@@ -141,6 +153,14 @@ The pre-commit hook runs `mvn spotless:check` and will fail the commit if there
141153
mvn spotless:apply
142154
```
143155

156+
## Projects Using This SDK
157+
158+
| Project | Description |
159+
|---------|-------------|
160+
| [JMeter Copilot Plugin](https://github.com/brunoborges/jmeter-copilot-plugin) | A JMeter plugin that integrates GitHub Copilot for AI-assisted load testing |
161+
162+
> Want to add your project? Open a PR!
163+
144164
## License
145165

146166
MIT

0 commit comments

Comments
 (0)