Skip to content

Commit

Permalink
Tweak readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Artem Sapegin committed Mar 12, 2018
1 parent f7879a5 commit 04d5a02
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# React Styleguidist example style guide

See [deployed version](https://react-styleguidist.js.org/examples/basic/).
This example is supposed to be used to reproduce issues, if you want to learn how to use React Styleguidist see [examples in the main repository](https://github.com/styleguidist/react-styleguidist/tree/master/examples).

![](http://wow.sapegin.me/3q0F1Y1P321k/Image%202016-04-12%20at%207.25.03%20PM.png)

How to start locally:
## How to start locally

```
git clone https://github.com/styleguidist/example.git react-styleguidist-example
Expand All @@ -14,3 +14,11 @@ npm start
```

Then open [http://localhost:6060](http://localhost:6060) in your browser.

## How to create a reproducible demo

1. Fork this repository (please don’t use the main, styleguidist/react-styleguidist, repository).
2. Modify it to reproduce the issue.
3. Push your changes to GitHub and paste the link into a GitHub issue.

Most likely you’ll find an issue yourself, while creating a demo.

0 comments on commit 04d5a02

Please sign in to comment.