From 2ccee4cf520e77fef8ec76cbd04867c546a1f308 Mon Sep 17 00:00:00 2001 From: Gil Barbara Date: Sun, 25 Nov 2018 23:21:34 -0200 Subject: [PATCH] Update README --- README.md | 34 ++++++++++++++++++++++------------ 1 file changed, 22 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 5bc2b2e..4a26585 100755 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -React-Redux-Saga Boilerplate -=== +# React-Redux-Saga Boilerplate [![Build Status](https://travis-ci.org/gilbarbara/react-redux-saga-boilerplate.svg?branch=master)](https://travis-ci.org/gilbarbara/react-redux-saga-boilerplate) [![Dependencies](https://david-dm.org/gilbarbara/react-redux-saga-boilerplate.svg)](https://david-dm.org/gilbarbara/react-redux-saga-boilerplate) [![Maintainability](https://api.codeclimate.com/v1/badges/eb66aa0049fa03acbbf3/maintainability)](https://codeclimate.com/github/gilbarbara/react-redux-saga-boilerplate/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/eb66aa0049fa03acbbf3/test_coverage)](https://codeclimate.com/github/gilbarbara/react-redux-saga-boilerplate/test_coverage) [Demo](https://redux-saga.react-boilerplate.com/) ### Provides + - react ^16.x - react-router 4.x - react-helmet 5.x @@ -14,27 +14,37 @@ React-Redux-Saga Boilerplate - redux-saga 0.16.x - redux-persist 5.x +### Development + +- webpack-dev-server 3.x +- react-hot-loader 4.x +- redux-devtools (with browser plugin) + +`npm start` + ### Building + - webpack 4.x - babel 7.x `npm run build` -### Development -- webpack-dev-server 3.x -- react-hot-loader 4.x -- redux-devtools (with browser plugin) +### Code Quality -`npm start` +- eslint 5.x +- stylelint 9.x + +`npm run lint` / `npm run lint:styles` + +### Unit Testing -### Tests - jest 23.x - enzyme 3.x -`npm test` or `npm run test:watch` +`npm test` + +### End 2 End Testing -### Browser Automation - cypress 3.0.x -`cypress run` (with dev-server already running) -`npm run test:automation` (start dev-server, run tests and exit) +`npm run test:e2e`