1
0
mirror of https://github.com/mizanxali/uno-online synced 2024-11-22 18:54:53 +00:00

Updated README

This commit is contained in:
Mizanali Panjwani 2021-03-05 05:31:32 +05:30
parent ffd734cde4
commit 6aaf27a141

View File

@ -1,13 +1,15 @@
<h1 align="center">UNO ONLINE</h1> <h1 align="center">UNO ONLINE</h1>
<h3 align="center">Two player online game of UNO.</h3> <h3 align="center">Two player online game of UNO.</h3>
<img src="client/src/assets/logo.png" alt="UNO Logo" width="75%" align="center" />
## 🤔 What is UNO? ## 🤔 What is UNO?
UNO is the classic and beloved card game thats easy to pick up and impossible to put down! Players take turns matching a card in their hand with the current card shown on top of the deck either by color or number. Special action cards deliver game-changing moments as they each perform a function to help you defeat your opponents. These include Skips, reverses, draw twos, color-changing wild and draw four wild cards. UNO is the classic and beloved card game thats easy to pick up and impossible to put down! Players take turns matching a card in their hand with the current card shown on top of the deck either by color or number. Special action cards deliver game-changing moments as they each perform a function to help you defeat your opponents. These include Skips, reverses, draw twos, color-changing wild and draw four wild cards.
## ⚠️ Game Rules ## ⚠️ Game Rules
Read the complete rules of UNO [here]('https://www.unorules.com/). Read the complete rules of UNO [here](https://www.unorules.com/).
## ❓ About the game ## ❓ About the game
@ -36,7 +38,7 @@ Follow the steps below, after cloning the repository:
### ⏳ Installation ### ⏳ Installation
- (At the root of the project directory, use npm to install the server-side dependencies) - At the root of the project directory, use npm to install the server-side dependencies
```bash ```bash
npm install npm install
@ -52,7 +54,7 @@ npm start
This command gets the server running on localhost port 5000. This command gets the server running on localhost port 5000.
- (In a separate terminal, navigate into the client folder and use npm to install the client-side dependencies) - In a separate terminal, navigate into the client folder and use npm to install the client-side dependencies
```bash ```bash
cd client cd client
@ -61,7 +63,7 @@ npm install
This command installs all the client-side dependencies needed for the game to run locally. This command installs all the client-side dependencies needed for the game to run locally.
- (Finally, use npm to run client) -Finally, use npm to run client
```bash ```bash
npm start npm start
@ -85,4 +87,4 @@ Contributions are what make the open source community such an amazing place to b
## ❤️ Acknowledgements ## ❤️ Acknowledgements
* [AlexDer]('https://alexder.itch.io/') for the UNO cards assets! * [AlexDer](https://alexder.itch.io/) for the UNO cards assets!