Skip to content

Commit 017a004

Browse files
Add README and update devcontainer with additional GitHub extensions
1 parent 8c53de8 commit 017a004

2 files changed

Lines changed: 65 additions & 1 deletion

File tree

.devcontainer/devcontainer.json

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,14 @@
1010
"customizations": {
1111
"vscode": {
1212
"extensions": [
13-
"github.vscode-github-actions"
13+
"GitHub.codespaces",
14+
"github.vscode-github-actions",
15+
"GitHub.copilot",
16+
"GitHub.copilot-chat",
17+
"github.copilot-workspace",
18+
"GitHub.vscode-pull-request-github",
19+
"GitHub.remotehub",
20+
"golang.Go"
1421
]
1522
}
1623
}

README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# gh-game
2+
3+
A GitHub CLI extension that allows you to play games through the GitHub CLI.
4+
5+
## Installation
6+
7+
```sh
8+
gh extension install chrisreddington/gh-game
9+
```
10+
11+
## Commands
12+
13+
### Coin Toss
14+
15+
Play a coin toss game where you try to guess whether the coin will land on heads or tails. Keep your streak going by guessing correctly!
16+
17+
```sh
18+
gh game cointoss heads # or tails
19+
```
20+
21+
The game will continue as long as you keep guessing correctly, allowing you to build up a streak. You can quit at any time by selecting "Quit" when prompted for your next guess.
22+
23+
### Whoami
24+
25+
Display information about the currently authenticated GitHub user.
26+
27+
```sh
28+
gh game whoami
29+
```
30+
31+
## Development
32+
33+
### Prerequisites
34+
35+
- Go 1.23 or newer
36+
- GitHub CLI installed
37+
38+
### Building from source
39+
40+
1. Clone the repository
41+
2. Run `go build` to build the extension
42+
3. Run `go test ./...` to run the tests
43+
44+
### Development Container
45+
46+
This project includes a [development container configuration](.devcontainer/devcontainer.json) for VS Code, which provides a consistent development environment with:
47+
- Go 1.23
48+
- GitHub CLI
49+
- Several VS Code extensions for GitHub
50+
51+
## Contributing
52+
53+
Contributions are welcome! Please feel free to submit a Pull Request.
54+
55+
## License
56+
57+
This project is available as open source under the terms of the [MIT License](LICENSE).

0 commit comments

Comments
 (0)