From f9a99ff0bdca42c0c55e7b74fa7f14f9398642a8 Mon Sep 17 00:00:00 2001 From: bward2 Date: Tue, 2 Jul 2019 00:08:38 -0500 Subject: [PATCH] Updating README (#67) --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index a6e4a43..6156574 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,21 @@ # pacman-js [![Build Status](https://travis-ci.com/bward2/pacman-js.svg?branch=master)](https://travis-ci.com/bward2/pacman-js) [![Coverage Status](https://coveralls.io/repos/github/bward2/pacman-js/badge.svg?branch=master)](https://coveralls.io/github/bward2/pacman-js?branch=master) +[![Code Style](https://img.shields.io/badge/code%20style-airbnb-brightgreen.svg)](https://github.com/airbnb/javascript) Pacman clone made with Javascript and HTML - *__[Play it!](https://bward2.github.io/pacman-js/)__* + +πŸ’πŸ“πŸŠπŸŽπŸˆπŸ‘ΎπŸ””πŸ”‘ + +## Development Instructions + +This project makes use of *__[NodeJS](https://nodejs.org/en/)__*. Download it, then clone this repo and run the following commands: +1. `npm i` (Installs necessary packages for development) +1. `gulp watch` (Watches changes to JS and SCSS files for continuous compilation) +1. `npm run serve` (Hosts the files locally) + +The game can now be accessed at *__http://127.0.0.1:8080/index__* + +This project also utilizes *__[Husky](https://github.com/typicode/husky)__* to enforce best coding practices. The current thresholds are 0 linting errors upon commits (following Airbnb's standard), and 100% unit test code coverage upon pushes. + +Feel free to submit PRs and/or report any issues you find! πŸ˜ƒ