Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
masechkacat authored Apr 29, 2024
1 parent 1a18531 commit bd57358
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Tic Tac Toe WebSocket API
# ![MyPortfolio](https://ziadoua.github.io/m3-Markdown-Badges/badges/MyPortfolio/myportfolio1.svg) Tic Tac Toe WebSocket API

## Overview

Expand All @@ -7,7 +7,11 @@ The Tic Tac Toe WebSocket API facilitates real-time interaction in a Tic Tac Toe
![Demo GIF](./assets/demo.gif)

## Technologies Used

![SocketIO](https://ziadoua.github.io/m3-Markdown-Badges/badges/SocketIO/socketio3.svg)
![NestJS](https://ziadoua.github.io/m3-Markdown-Badges/badges/NestJS/nestjs1.svg)
![Jest](https://ziadoua.github.io/m3-Markdown-Badges/badges/Jest/jest2.svg)
![TypeScript](https://ziadoua.github.io/m3-Markdown-Badges/badges/TypeScript/typescript2.svg)
![NPM](https://ziadoua.github.io/m3-Markdown-Badges/badges/npm/npm1.svg)
- **NestJS version:** 10.3.8
- **Socket.IO version:** 4.7.5
- Important: To ensure compatibility, the Socket.IO client version must match the server version. You can use the following CDN for the client:
Expand Down Expand Up @@ -59,10 +63,10 @@ Tests are written for both the game service and the gateway.
## Documentation
The server's API is documented using AsyncAPI. Documentation is auto-generated by script `.github/workflows/asyncapi-docs.yml` and published via GitHub Actions to: [Tic Tac Toe WebSocket API 1.0.0](https://masechkacat.github.io/tic-tac-toe-server/)

You can also view the documentation locally using the [AsyncAPI Viewer](https://studio.asyncapi.com/) by loading the asyncapi.yaml file from the repository.
You can also view the documentation locally using the [AsyncAPI Viewer](https://studio.asyncapi.com/) by loading the `asyncapi.yaml` file from the repository.

## Example Client
A simple client implementation is deployed at [client URL]()
A simple client implementation is deployed at [client](https://masechkacat.github.io/tic-tac-toe-client/)

## Server Usage Information

Expand Down Expand Up @@ -106,4 +110,5 @@ Users can send moves to the server:

## License

Nest is [MIT licensed](LICENSE).
![GitHub license](https://ziadoua.github.io/m3-Markdown-Badges/badges/LicenceMIT/licencemit2.svg)

0 comments on commit bd57358

Please sign in to comment.