readme updates, travis_wait

.travis.yml

@@ -11,7 +11,7 @@ install:
 
 script:
   - npm test
-  - npm run build
+  - travis_wait npm run build
 
 after_success:
   - pip install --user awscli

README.md

@@ -1,33 +1,99 @@
-# blog
+<p align="center">
+  <a href="https://kremalicious.com"><img src="src/images/github-header.png" /></a>
+ </p>
+<p align="center">
+  <strong>🍭 My blog built with <a href="http://gatsbyjs.org">Gatsby</a>. Neat.</strong>
+</p>
+<p align="center">
+  <a href="https://kremalicious.com">kremalicious.com</a>
+</p>
+<p align="center">
+  <a href="https://travis-ci.com/kremalicious/blog"><img src="https://travis-ci.com/kremalicious/blog.svg?branch=master" /></a>
+  <a href="https://codeclimate.com/github/kremalicious/blog/maintainability"><img src="https://api.codeclimate.com/v1/badges/4e86c791349cd12368cd/maintainability" /></a>
+  <a href="https://www.codacy.com/app/kremalicious/blog?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=kremalicious/blog&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/63a594f4e2324b22986068ef2400ed87"/></a>
+  <a href="https://greenkeeper.io/"><img src="https://badges.greenkeeper.io/kremalicious/blog.svg" /></a>
+</p>
 
-> 🍭 My blog [kremalicious.com](http://kremalicious.com) built with [Gatsby](http://gatsbyjs.org). Neat.
+## Table of Contents
 
-[![Build Status](https://travis-ci.com/kremalicious/blog.svg?branch=master)](https://travis-ci.com/kremalicious/blog)
-[![Maintainability](https://api.codeclimate.com/v1/badges/4e86c791349cd12368cd/maintainability)](https://codeclimate.com/github/kremalicious/blog/maintainability)
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/22716f4e00d14df8991af76384193953)](https://www.codacy.com/app/kremalicious/blog)
-[![Greenkeeper badge](https://badges.greenkeeper.io/kremalicious/blog.svg)](https://greenkeeper.io/)
+---
 
-## Requirements
+## 🎉 Features
+
+The whole [blog](https://kremalicious.com) is a React-based Single Page App built with [Gatsby v2](https://www.gatsbyjs.org).
+
+### EXIF extraction
+
+...
+
+### 🏆 SEO component
+
+Includes a SEO component which automatically switches all required `meta` tags for search engines, Twitter Cards, and Facebook OpenGraph tags based on the browsed route/page.
+
+If you want to know how, have a look at the respective component under [`src/components/atoms/SEO.jsx`](src/components/atoms/SEO.jsx)
+
+### 📈 Matomo (formerly Piwik) analytics tracking
+
+Site sends usage statistics to my own [Matomo](https://matomo.org) installation. To make this work in Gatsby, I created and open sourced a plugin, [gatsby-plugin-matomo](https://github.com/kremalicious/gatsby-plugin-matomo), which is in use on this site.
+
+### 💎 Importing SVG assets
+
+All SVG assets under `src/images/` will be converted to React components with the help of [gatsby-plugin-svgr](https://github.com/zabute/gatsby-plugin-svgr). Makes use of [SVGR](https://github.com/smooth-code/svgr) so SVG assets can be imported like so:
+
+```js
+import { ReactComponent as Logo } from './components/svg/Logo'
+
+<Logo />
+```
+
+### 🍬 Typekit component
+
+Includes a component for adding the Typekit snippet.
+
+If you want to know how, have a look at the respective component under [`src/components/atoms/Typekit.jsx`](src/components/atoms/Typekit.jsx)
+
+## ✨ Development
 
 You need to have the following tools installed on your development machine before moving on:
 
 - [Node.js](http://nodejs.org/)
 - [npm](https://npmjs.org/)
 
-## Development
+### 🔮 Linting
+
+ESlint, Prettier, and Stylelint are setup for all linting purposes:
 
 ```bash
-npm i
-npm start
+npm run lint
 ```
 
-## Production build
+To automatically format all code files:
 
 ```bash
-npm run build
+npm run format
+npm run format:css
 ```
 
-## Licenses
+### 🎈 Add a new project
+
+...
+
+## 🚚 Deployment
+
+Automatic deployments are triggered upon successful tests & builds on Travis:
+
+- push to `master` initiates a live deployment
+- any Pull Request, and subsequent pushes to it, initiates a beta deployment
+
+The deploy command simply calls the [`scripts/deploy.sh`](scripts/deploy.sh) script, syncing the contents of the `public/` folder to S3:
+
+```bash
+npm run deploy
+```
+
+The deploymeng script can be used locally too, the branch checks are only happening for Travis builds, allowing to deploy any branch from local machine.
+
+## 🏛 Licenses
 
 The MIT License (MIT)