diff --git a/README.md b/README.md index 3d513eab..2fd0356a 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,17 @@ Small web app for watching movies easily. Check it out at **[movie.squeezebox.de ## Credits - Thanks to [@JipFr](https://github.com/JipFr) for initial work on [movie-cli](https://github.com/JipFr/movie-cli) - Thanks to [@mrjvs](https://github.com/mrjvs) for help porting to React, and for the beautiful design + +## Installation +To run this project locally for contributing or testing, run the following commands: + +``` +git clone https://github.com/JamesHawkinss/movie-web +cd movie-web +yarn install +yarn start +``` +To build production files, simply run `yarn build`. + +## Contributing +Check out [this project's issues](https://github.com/JamesHawkinss/movie-web/issues) for inspiration for contribution. Pull requests are always welcome. \ No newline at end of file