Updated readme

This commit is contained in:
Eunchong Kim 2021-07-29 22:04:28 +09:00
parent 958f1d5374
commit 54da74f8d0

View File

@ -1,29 +1,56 @@
# UNO game written in JavaScript for HTML
FEATURES:
- Standalone: no need any other source
- Only one file: so load only one JS file
- Single player mode: No server required
- Multi player mode (on progress)
I used:
- JavaScript
- webpack and some loaders: to pack to one file
- [Wallpaper Access](https://wallpaperaccess.com/): Background image
- [Wallpaper Access](https://wallpaperaccess.com/): used for background image
- [UNO card deck images as svg](https://commons.wikimedia.org/wiki/File:UNO_cards_deck.svg) and [UNO card back image as svg](https://eperezcosano.github.io/uno-part1/)
## 1. Demonstration
DEMO is available on the GitHub page.
[DEMO on GitHub page](https://newini.github.io/uno-game-js/)
## 2. Installation
TBA
### 2.1 Use CDN
The code is available on GitHub.
```
<script src='https://raw.githubusercontent.com/newini/uno-game-js/master/uno_game.js'></script>
```
### 2.2 Direct download
Download from GitHub,
```
wget https://raw.githubusercontent.com/newini/uno-game-js/master/uno_game.js
```
and add load uno game js from HTML.
```
<script src='uno_game.js'></script>
```
## 3. How to use?
Put these lines in the HTML body.
### 3.1 Configuration
TBA
### 3.2 Put game view
Put this one line in the HTML body.
```
<div id='uno-game'></div>
<script src='main.js'></script>
```
## 4. For developers