Skip to content
This repository has been archived by the owner on Mar 31, 2021. It is now read-only.

Commit

Permalink
fix: update README examples (#27)
Browse files Browse the repository at this point in the history
  • Loading branch information
felixjung authored Dec 2, 2020
1 parent 0964ba0 commit 9eee872
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,6 @@ A [create-react-app template](https://create-react-app.dev/docs/custom-templates
- [Linting your code](#linting-your-code)
- [Writing tests](#writing-tests)
- [📖 Useful resources](#-useful-resources)
- [💁‍♀ Tips](#-tips)
- [Setting up Foundry's ESLint in your editor](#setting-up-foundrys-eslint-in-your-editor)
- [Visual Studio Code](#visual-studio-code)
- [⚠️ Troubleshooting](#️-troubleshooting)
- [Debug mode](#debug-mode)
- [Broken build due to ESLint version](#broken-build-due-to-eslint-version)
Expand All @@ -34,7 +31,7 @@ A [create-react-app template](https://create-react-app.dev/docs/custom-templates

1. Open your terminal.
2. Navigate to the directory you would like to place your project in.
3. Run `yarn create react-app --template @sumup`, where `my-app` is the name of your project.
3. Run `yarn create react-app my-app --template @sumup`, where `my-app` is the name of your project.

This will create the folder `my-app` and initialize a new project inside. The project will be based on [`create-react-app`](https://github.com/facebook/create-react-app) and will use SumUp's [`Circuit UI`](https://circuit.sumup.com/) component library and [Foundry](https://github.com/sumup/foundry) toolkit.

Expand All @@ -50,11 +47,11 @@ To create a production build of your app, run `yarn build`. `react-scripts` will

### Adding a new component

We try making adding new components as easy as possible. Run `yarn create:component YourComponentName` to launch the plop CLI exposed and configured by Foundry.
We try to make adding new components as easy as possible. Run `yarn create:component YourComponentName` to launch the plop CLI exposed and configured by Foundry.

<div align="center">

![A GIF of how to use the create-component script.](./github/create-component.gif 'Using create-component')
![A GIF of how to use the create:component script.](./github/create-component.gif 'Using create:component')

</div>

Expand Down Expand Up @@ -91,7 +88,7 @@ import { render } from '../../test-utils';
`create-react-app` has a debug mode. To output verbose logging to your console, add the `--debug` flag when creating your app. For example:

```
yarn create @sumup/create-app my-debugging-app --debug
yarn create react-app my-debugging-app --debug --template @sumup
```

### Broken build due to ESLint version
Expand Down

0 comments on commit 9eee872

Please sign in to comment.