Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
l-yang-05 authored Oct 11, 2019
1 parent 7af6c37 commit 770d0d7
Showing 1 changed file with 36 additions and 1 deletion.
37 changes: 36 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,36 @@
# Number-Guessing-Game
# Number-Guessing-Game

This application is a number guessing game where users are allowed to make guesses to see if how many tries it takes them to get the correct number. The number of tries will equivalent to their score in the game. Users can select two difficulties, Standard (In this level, you will only guess between the numbers 1-10) and Hard (In this level, you will only guess between the numbers 1-100). After winning the game, users are allowed to keep playing if they would like to beat their high score. Take a shot and try beating your score today, I know you can do it :).

## Getting Started

Clone or download this repo onto your local machine. Once you have done this, install the node packages. You can do this by running ```npm i``` on your command line tool.


## Running the app

After you have installed all of the dependencies that are needed for this project, you can open the project up through your command line tool. First be in the root of the directory and then run ```npm run start``` in your command line tool. This will start the React app server, opening the application.


## Stopping the app

To stop running the server and the react app, you can hit ```command + z``` to close both.


## Tests

To run the tests for the application run the command ```npm run test```.

## Built With

* [React](https://github.com/facebook/react) - The framework used
* [Netlify] (https://lucy-yang-portfolio.netlify.com) - Deployment site

## Author

* [Lucy Yang](https://github.com/l-yang-05)


## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

0 comments on commit 770d0d7

Please sign in to comment.