Skip to content

Commit 4506238

Browse files
committed
Update README with badges, URLs, and environments table
- Add CI/Deploy status badges - Add prominent links to website and SSH endpoints - Add environments table (prod/staging/dev) - Add contributing section
1 parent 469011c commit 4506238

1 file changed

Lines changed: 26 additions & 3 deletions

File tree

README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,18 @@
22

33
**SSH into chess mastery.**
44

5+
[![CI](https://github.com/ghndrx/shellmate/actions/workflows/ci.yml/badge.svg)](https://github.com/ghndrx/shellmate/actions/workflows/ci.yml)
6+
[![Deploy](https://github.com/ghndrx/shellmate/actions/workflows/deploy.yml/badge.svg)](https://github.com/ghndrx/shellmate/actions/workflows/deploy.yml)
7+
58
```bash
69
ssh play@shellmate.sh
710
```
811

12+
🌐 **Website:** [shellmate.sh](https://shellmate.sh)
13+
🎮 **Play:** `ssh play@shellmate.sh`
14+
📚 **Learn:** `ssh learn@shellmate.sh`
15+
👀 **Watch:** `ssh watch@shellmate.sh`
16+
917
> *Experience chess in your terminal. Play against AI, challenge friends, or master the game with interactive tutorials.*
1018
1119
## ✨ Features
@@ -77,13 +85,28 @@ ssh -p 2222 play@localhost
7785

7886
See [docs/self-hosting.md](docs/self-hosting.md) for configuration options.
7987

88+
## 🔗 Environments
89+
90+
| Environment | Website | SSH |
91+
|-------------|---------|-----|
92+
| **Production** | [shellmate.sh](https://shellmate.sh) | `ssh play@shellmate.sh` |
93+
| **Staging** | [staging.shellmate.sh](https://staging.shellmate.sh) | `ssh play@staging.shellmate.sh` |
94+
| **Development** | [dev.shellmate.sh](https://dev.shellmate.sh) | `ssh play@dev.shellmate.sh` |
95+
96+
## 🤝 Contributing
97+
98+
1. Fork the repo
99+
2. Create a feature branch (`git checkout -b feature/awesome`)
100+
3. Commit changes (`git commit -m 'Add awesome feature'`)
101+
4. Push to branch (`git push origin feature/awesome`)
102+
5. Open a PR to `develop`
103+
104+
See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
105+
80106
## 📝 License
81107

82108
MIT
83109

84110
---
85111

86-
**Website:** [shellmate.sh](https://shellmate.sh)
87-
**Game:** `ssh play@shellmate.sh`
88-
89112
*Built with ♟️ by [Greg Hendrickson](https://gregh.dev)*

0 commit comments

Comments
 (0)