Skip to content

Commit 17c4358

Browse files
committed
update readme
1 parent 7cbf617 commit 17c4358

File tree

1 file changed

+33
-33
lines changed

1 file changed

+33
-33
lines changed

README.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
1-
# minimal-react-webpack-babel-setup
2-
3-
[![Build Status](https://travis-ci.org/rwieruch/minimal-react-webpack-babel-setup.svg?branch=master)](https://travis-ci.org/rwieruch/minimal-react-webpack-babel-setup) [![Slack](https://slack-the-road-to-learn-react.wieruch.com/badge.svg)](https://slack-the-road-to-learn-react.wieruch.com/) [![Greenkeeper badge](https://badges.greenkeeper.io/rwieruch/minimal-react-webpack-babel-setup.svg)](https://greenkeeper.io/)
4-
5-
Read how to set it up yourself: [React with Webpack Tutorial](https://www.robinwieruch.de/minimal-react-webpack-babel-setup/).
6-
7-
[![Edit minimal-react-webpack-babel-setup](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/rwieruch/minimal-react-webpack-babel-setup/tree/master/?fontsize=14)
8-
9-
## Features
10-
11-
* React 16
12-
* Webpack 4
13-
* Babel 7
14-
* Hot Module Replacement
15-
16-
## DIY Add-Ons
17-
18-
* [ESLint](https://www.robinwieruch.de/react-eslint-webpack-babel/)
19-
* [SVG Icons](https://www.robinwieruch.de/react-svg-icon-components/)
20-
* [Fonts Support](https://www.robinwieruch.de/webpack-font/)
21-
* [Images Support](https://www.robinwieruch.de/webpack-images/)
22-
23-
## Alternatives
24-
25-
* [Advanced React Webpack Babel Setup](https://github.com/rwieruch/advanced-react-webpack-babel-setup)
26-
27-
## Installation
28-
29-
* `git clone git@github.com:rwieruch/minimal-react-webpack-babel-setup.git`
30-
* cd minimal-react-webpack-babel-setup
31-
* npm install
32-
* npm start
33-
* visit `http://localhost:8080/`
1+
# A Chrome extension boilerplate.
2+
3+
## Basic Usage
4+
5+
```
6+
yarn
7+
yarn dev
8+
```
9+
10+
## features:
11+
> 1. Support for ES7 ( with Babel and polyfill)
12+
> 2. popup page with reactjs and material ui framework
13+
> 3. Content script with reactjs and material ui framework
14+
> 4. Bundling (webpack)
15+
16+
## directory structure
17+
> * `src/` is root directory for a chrome extension. it includes `manifest.json` file and other static stuff.
18+
19+
> * `src/background.js` is main background js file for the chrome extension.
20+
21+
> * `popup-page` is the directory which includes react js setup for popup page.
22+
23+
> * `content-scripts` is the directory directory which includes react js setup for content script.
24+
25+
> * `src/utils` is the directory for utilities that can be written in es6,es7 or es8...
26+
27+
## How to extend ?
28+
29+
> * Write chrome extension's background scripts code in `src/background.js`
30+
31+
> * Write chrome extension's popup page codes in `popup-page` Reactjs directory system.
32+
33+
> * Write chrome extension's content scripts codes in `content-scripts` Reactjs directory system.

0 commit comments

Comments
 (0)