Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cjkihl committed Jul 31, 2018
1 parent 07c7d99 commit 16e654a
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ https://caki0915.github.io/gatsby-starter-redux/

## Features

* [Redux](https://github.com/reactjs/redux) and [Redux-devtools](https://github.com/gaearon/redux-devtools).
* [Emotion](https://github.com/emotion-js/emotion) with a basic theme and SSR
* [Typography.js](https://kyleamathews.github.io/typography.js/)
* Eslint rules based on Prettier and Airbnb
- [Redux](https://github.com/reactjs/redux) and [Redux-devtools](https://github.com/gaearon/redux-devtools).
- [Emotion](https://github.com/emotion-js/emotion) with a basic theme and SSR
- [Typography.js](https://kyleamathews.github.io/typography.js/)
- Eslint rules based on Prettier and Airbnb

## Install

Expand All @@ -23,6 +23,20 @@ Install this starter (assuming Gatsby is installed) by running from your CLI:
gatsby new your-project-name https://github.com/caki0915/gatsby-starter-redux
```

## Formatting and Linting

Formatting and lint is done with [Prettier](https://prettier.io/) and [Eslint](https://eslint.org/)

`npm run format` for formatting
`npm run lint` for linting

## Deploy

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/caki0915/gatsby-starter-redux)

## Contribute

Contributions are more than welcome! Please fork and make pull requests

The only guideline is that this should be the cleanest easy to use starter.
Happy coding! :smile:

0 comments on commit 16e654a

Please sign in to comment.