Skip to content

Commit

Permalink
Improved the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
programarivm committed Jan 26, 2024
1 parent d48ab11 commit d00fef9
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 28 deletions.
12 changes: 1 addition & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,13 @@
## PHP Chess Server

[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Contributing](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/dwyl/esta/issues)
[![Contributors](https://img.shields.io/github/contributors/chesslablab/chess-server)](https://github.com/chesslablab/chess-server/graphs/contributors)

Asynchronous PHP chess server.

### Connect to the WebSocket Server

Open a console in your favorite browser and run the following commands:

```
const ws = new WebSocket('wss://async.chesslablab.org:8443');
ws.send('/start classical fen');
```

### Documentation

Read the latest docs [here](https://php-chess-server.chesslablab.org/).
Read the latest docs [here](https://chess-server.docs.chesslablab.org/).

### License

Expand Down
3 changes: 3 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# PHP Chess Server

[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Contributors](https://img.shields.io/github/contributors/chesslablab/chess-server)](https://github.com/chesslablab/chess-server/graphs/contributors)

PHP Chess Server is an asynchronous PHP server that provides functionality to play chess online over a WebSocket connection as well as over a TCP connection.

Similar to the [Chess API](https://chess-api.readthedocs.io/en/latest/), it can be hosted on a custom domain. However, while the API endpoints may take few seconds to execute — for example, a file download or a database query — the event-driven, non-blocking architecture of the chess server allows to handle multiple concurrent connections in an efficient way.
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
site_name: PHP Chess Server
nav:
- PHP Chess Server: index.md
- Home: index.md
- Installation: installation.md
- Getting Started: getting-started.md
- /start: start.md
Expand Down
16 changes: 0 additions & 16 deletions readthedocs.yaml

This file was deleted.

0 comments on commit d00fef9

Please sign in to comment.