Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SpaceK33z committed Sep 9, 2017
1 parent 8dce5f9 commit 3faf81b
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Expand Up @@ -3,15 +3,14 @@
Create React apps with no build configuration.

* [Getting Started](#getting-started) – How to create a new app.
* [User Guide](https://github.com/CodeYellowBV/create-react-cy-app/blob/master/packages/react-cy-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
* [User Guide](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.

- - -

**This is a fork of [Create React App](https://github.com/facebookincubator/create-react-app), intended for use at our company Code Yellow B.V.**

The main differences with Create React App are;

Changes with create-react-app
- No CSS Autoprefixer, we only support modern browsers
- Uses cache-loader to cache Babel output
- Doesn't use source maps by default
Expand All @@ -27,3 +26,14 @@ Changes with create-react-app
- Uses styled-components babel plugin
- Uses decorator babel plugin

## Getting Started

```sh
npm install -g create-react-app

create-react-app --scripts-version=react-cy-scripts my-app
cd my-app/
npm start
```

For further instructions, read the [Getting Started guide](https://github.com/facebookincubator/create-react-app#getting-started) from the original Create React App.

0 comments on commit 3faf81b

Please sign in to comment.