Skip to content

Commit f092688

Browse files
authored
Merge pull request #32 from mvhk/master
Readme updated
2 parents 2e56203 + 11538ba commit f092688

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
1-
# React Boilerplate
1+
# [React Boilerplate](http://react-simple-boilerplate.surge.sh/)
22

3-
A simple react boilerplate with webpack hmr and latest babel packages. It comes with inbuilt travis ci for PR checks, lint checks and builds.
3+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/udaypydi/react-simple-boilerplate/blob/master/CONTRIBUTING.md) ![](https://img.shields.io/travis/udaypydi/react-simple-boilerplate)
44

5+
A simple react boilerplate with webpack hmr and latest babel packages. It comes with inbuilt [Travis-CI](https://travis-ci.org/) for PR checks, lint checks and builds.
6+
7+
## Getting Started
8+
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
9+
10+
### Prerequisites
11+
* [yarn](https://classic.yarnpkg.com/en/docs/install/)
12+
* [node](https://nodejs.org/en/download/)
13+
14+
15+
### Installing
516
- Install npm packages using `yarn install`
617

718
- Run in dev mode
@@ -12,6 +23,3 @@ A simple react boilerplate with webpack hmr and latest babel packages. It comes
1223

1324
- Run test cases
1425
`npm run test`
15-
16-
## Want To Submit A PR?
17-
Refer [Contributing.md](https://github.com/udaypydi/react-simple-boilerplate/blob/master/CONTRIBUTING.md)

0 commit comments

Comments
 (0)