mirror of
https://github.com/ghndrx/shellmate.git
synced 2026-02-10 06:45:02 +00:00
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
This commit is contained in:
29
README.md
29
README.md
@@ -2,10 +2,18 @@
|
||||
|
||||
**SSH into chess mastery.**
|
||||
|
||||
[](https://github.com/ghndrx/shellmate/actions/workflows/ci.yml)
|
||||
[](https://github.com/ghndrx/shellmate/actions/workflows/deploy.yml)
|
||||
|
||||
```bash
|
||||
ssh play@shellmate.sh
|
||||
```
|
||||
|
||||
🌐 **Website:** [shellmate.sh](https://shellmate.sh)
|
||||
🎮 **Play:** `ssh play@shellmate.sh`
|
||||
📚 **Learn:** `ssh learn@shellmate.sh`
|
||||
👀 **Watch:** `ssh watch@shellmate.sh`
|
||||
|
||||
> *Experience chess in your terminal. Play against AI, challenge friends, or master the game with interactive tutorials.*
|
||||
|
||||
## ✨ Features
|
||||
@@ -77,13 +85,28 @@ ssh -p 2222 play@localhost
|
||||
|
||||
See [docs/self-hosting.md](docs/self-hosting.md) for configuration options.
|
||||
|
||||
## 🔗 Environments
|
||||
|
||||
| Environment | Website | SSH |
|
||||
|-------------|---------|-----|
|
||||
| **Production** | [shellmate.sh](https://shellmate.sh) | `ssh play@shellmate.sh` |
|
||||
| **Staging** | [staging.shellmate.sh](https://staging.shellmate.sh) | `ssh play@staging.shellmate.sh` |
|
||||
| **Development** | [dev.shellmate.sh](https://dev.shellmate.sh) | `ssh play@dev.shellmate.sh` |
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
1. Fork the repo
|
||||
2. Create a feature branch (`git checkout -b feature/awesome`)
|
||||
3. Commit changes (`git commit -m 'Add awesome feature'`)
|
||||
4. Push to branch (`git push origin feature/awesome`)
|
||||
5. Open a PR to `develop`
|
||||
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
|
||||
|
||||
## 📝 License
|
||||
|
||||
MIT
|
||||
|
||||
---
|
||||
|
||||
**Website:** [shellmate.sh](https://shellmate.sh)
|
||||
**Game:** `ssh play@shellmate.sh`
|
||||
|
||||
*Built with ♟️ by [Greg Hendrickson](https://gregh.dev)*
|
||||
|
||||
Reference in New Issue
Block a user