Commit 095c6fbe authored by Dmitriy Derepko's avatar Dmitriy Derepko Committed by GitHub

docs: Improve readme styles (#37)

parent 59755fa9
...@@ -14,12 +14,16 @@ Pull to refresh with react ...@@ -14,12 +14,16 @@ Pull to refresh with react
## Demo ## Demo
[See the demo in action at https://echoulen.github.io/react-pull-to-refresh/](https://echoulen.github.io/react-pull-to-refresh/) [See the demo in action at https://echoulen.github.io/react-pull-to-refresh/](https://echoulen.github.io/react-pull-to-refresh/)
## installation ## Installation
`npm install react-js-pull-to-refresh --save` ```bash
npm install react-js-pull-to-refresh --save
```
or or
`yarn add react-js-pull-to-refresh` ```bash
yarn add react-js-pull-to-refresh
```
## Props ## Props
|Name|Type|Required |Name|Type|Required
...@@ -35,18 +39,18 @@ or ...@@ -35,18 +39,18 @@ or
## Usage ## Usage
#### import PullToRefresh ### Import PullToRefresh
```js ```js
import {PullToRefresh} from "react-js-pull-to-refresh"; import {PullToRefresh} from "react-js-pull-to-refresh";
``` ```
#### import default content (optional) ### Import default content (optional)
```typescript ```typescript
import {PullDownContent, ReleaseContent, RefreshContent} from "react-js-pull-to-refresh"; import {PullDownContent, ReleaseContent, RefreshContent} from "react-js-pull-to-refresh";
``` ```
#### Sample ### Sample
```jsx ```jsx
<PullToRefresh <PullToRefresh
pullDownContent={<PullDownContent />} pullDownContent={<PullDownContent />}
...@@ -68,4 +72,6 @@ import {PullDownContent, ReleaseContent, RefreshContent} from "react-js-pull-to- ...@@ -68,4 +72,6 @@ import {PullDownContent, ReleaseContent, RefreshContent} from "react-js-pull-to-
[Link](https://github.com/echoulen/react-pull-to-refresh/blob/master/examples/Basic.tsx) [Link](https://github.com/echoulen/react-pull-to-refresh/blob/master/examples/Basic.tsx)
## Contributing ## Contributing
`npm run dev` ```bash
npm run dev
```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment