Skip to content

Commit

Permalink
chore: update readme and storybook styles
Browse files Browse the repository at this point in the history
  • Loading branch information
nerdyman committed Feb 23, 2020
1 parent a3343a8 commit 1604a0f
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
4 changes: 4 additions & 0 deletions .storybook/preview-head.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,8 @@
width: 100%;
max-height: 100vh;
}

.docblock-source {
background: #272527 !important;
}
</style>
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,6 @@

See Storybook for [documentation](https://react-compare-slider.netlify.com/?path=/docs/docs-intro--page) and [demos](https://react-compare-slider.netlify.com/?path=/docs/demos-images--default).

See the [Image Playground](https://react-compare-slider.netlify.com/?path=/docs/demos-images--playground)
to experiment with image props using the "Knobs" tab.


## Usage

### Install
Expand All @@ -68,6 +64,9 @@ import { ReactCompareSlider, ReactCompareSliderImage } from 'react-compare-slide
/>
```

See the [Image Playground](https://react-compare-slider.netlify.com/?path=/docs/demos-images--playground)
to experiment with images using the "Knobs" tab.

### Advanced Usage

See the [docs](https://react-compare-slider.netlify.com/?path=/docs/docs-intro--page) for advanced examples.
Expand All @@ -89,8 +88,10 @@ See the [API docs](https://react-compare-slider.netlify.com/?path=/docs/docs-api

### Custom Components

Custom components can get the same base styles as `ReactCompareSliderImage`
by using the `styleFitContainer` CSS utility. See the [styleFitContainer docs](https://react-compare-slider.netlify.com/?path=/docs/docs-api--page#stylefitcontainer)
Custom components can apply the same base styles as `ReactCompareSliderImage`
by using the `styleFitContainer` CSS utility.

See the [styleFitContainer docs](https://react-compare-slider.netlify.com/?path=/docs/docs-api--page#stylefitcontainer)
for more information.

### Images
Expand Down

0 comments on commit 1604a0f

Please sign in to comment.