diff --git a/README.md b/README.md index 7db80e4..412c76b 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,47 @@ -# README +# Set Game -This README would normally document whatever steps are necessary to get the -application up and running. +Set Game is single page app that lets user play the game SET. -Things you may want to cover: +![Set Game](https://user-images.githubusercontent.com/8761638/69589475-2f4b0200-0fba-11ea-8f41-5a131079261f.png) -* Ruby version +## Demo -* System dependencies +You can watch a live demo of the app [here](#) or visit [https://best-set-game.netlify.com](https://best-set-game.netlify.com) to play! -* Configuration +## Technology Used -* Database creation +* Vanilla JavaScript +* Ruby on Rails +* PostgreSQL database +* Semantic UI +* Custom CSS -* Database initialization +The GitHub repo for the backend can be found [here](https://github.com/aresnik11/set-game-backend). -* How to run the test suite +## Features -* Services (job queues, cache servers, search engines, etc.) +Set Game allows users to: -* Deployment instructions +* Start a new game +* Read the rules of how to play +* See high scores +* Select cards that may be a set +* Visually see if selected cards are a correct set +* Check if there is a set on the board +* Visually see if there is a set on the board, if there is not, the cards will reshuffle +* See how much time has elapsed in their game +* Pause the game +* See how many cards are remaining in the deck -* ... +## How To Use + +Visit [https://best-set-game.netlify.com](https://best-set-game.netlify.com) to play! + +To test on your own machine: +1. Visit the backend repo [here](https://github.com/aresnik11/set-game-backend) and follow instructions on the README. The backend server should be started before the next steps are run. +2. Clone this repository +3. Update all fetch request urls in `index.js` to the url where your rails server is running +4. In terminal run `npm install` +5. In terminal run `npm start` + +## Enjoy! diff --git a/index.html b/index.html index eed81ee..4218133 100644 --- a/index.html +++ b/index.html @@ -3,6 +3,12 @@