diff --git a/README.md b/README.md index 90f80fd..7c67a09 100644 --- a/README.md +++ b/README.md @@ -1 +1,25 @@ -# lightbox \ No newline at end of file +# Lightbox Assignment + +A web app that displays Flickr photo grid with lightbox view. Implemented with vanilla JavaScript. + +![App screen shot](src/assests/images/lb-ss.png?raw=true) + +## Live demo + +[https://s3.amazonaws.com/light-box/index.html](https://s3.amazonaws.com/light-box/index.html) + +## Install + +1. Install [brew](http://brew.sh/): `ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"` + +2. Install git and node: `brew install git node` + +3. Install gulp globally by running: `npm install -g gulp` + +4. Clone project: `git clone https://github.com/mistermendez/lightbox.git` + +5. After cloning, just `cd` in there, install dependencies by running `npm install` + +6. Build the project by running `gulp` + +7. Open in `/dist/index.html` browser. \ No newline at end of file diff --git a/src/assets/images/lb-ss.png b/src/assets/images/lb-ss.png new file mode 100644 index 0000000..4732fae Binary files /dev/null and b/src/assets/images/lb-ss.png differ