Skip to content

Commit

Permalink
docs: fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ahmnouira committed Aug 21, 2021
1 parent 8879e90 commit 783300f
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,19 @@
<a href="https://david-dm.org/ahmnouira/ionic-react-header-parallax?type=dev"><img src="https://david-dm.org/ahmnouira/ionic-react-header-parallax/dev-status.svg"></a>
</p>

# Installation with npm
## Installation with npm

```sh
npm install ionic-react-header-parallax --save
```

## Installation with yarn

```sh
yarn add ionic-react-header-parallax
```

# Example
## Example

```tsx
import * as React from 'react'
Expand Down Expand Up @@ -76,8 +78,8 @@ const Home: React.FC = () => {

```

# API
## API

- [useIonHeaderParallax](https://github.com/ahmnouira/hooks#ionic-react-header-parallax)
- [useIonHeaderParallax](https://github.com/ahmnouira/ionic-react-header-parallax#useIonHeaderParallax)

## `useIonHeaderParallax`
### `useIonHeaderParallax`

0 comments on commit 783300f

Please sign in to comment.