Skip to content

Commit

Permalink
start rework the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
toviszsolt committed Mar 27, 2024
1 parent 4caf390 commit 5d0d78e
Showing 1 changed file with 21 additions and 6 deletions.
27 changes: 21 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
[![GitHub License](https://img.shields.io/github/license/toviszsolt/react-scrollspy?style=flat)](https://github.com/toviszsolt/react-scrollspy/blob/main/LICENSE)
[![npm](https://img.shields.io/npm/v/react-scrollspy?style=flat&color=red)](https://www.npmjs.com/package/react-scrollspy-navigation)
[![GitHub Repo stars](https://img.shields.io/github/stars/toviszsolt/react-scrollspy?color=DAAA3F)](https://github.com/toviszsolt/react-scrollspy/stargazers)
[![Run tests](https://github.com/toviszsolt/react-scrollspy/actions/workflows/main.yml/badge.svg)](https://github.com/toviszsolt/react-scrollspy/actions/workflows/main.yml)
[![NPM Downloads](https://img.shields.io/npm/dw/react-scrollspy-navigation?style=flat)](https://www.npmjs.com/package/react-scrollspy-navigation)
[![Sponsor](https://img.shields.io/static/v1?label=sponsor&message=❤&color=ff69b4)](https://github.com/sponsors/toviszsolt)

## ![Poster](assets/poster.png)

# React Scrollspy Component
Expand All @@ -8,16 +15,18 @@ on a navigation component.

**[Demo with example code](https://mvzn2.csb.app/)**

**[Sponsor me on Github](https://github.com/sponsors/toviszsolt)**

**[Sponsor me on PayPal](https://paypal.me/toviszsolt)**

## How to install

Install via NPM package manager
Install via NPM or Yarn package manager

```
npm i react-scrollspy-navigation
```

Install via Yarn package manager

```
yarn add react-scrollspy-navigation
```
Expand Down Expand Up @@ -98,10 +107,16 @@ Available `ScrollSpy` component properties
`0`, unit: `px`)
- `duration` - the scroll animation duration, when you click on a navigation item (default: `1000`, unit: `ms`)

## Sponsorship
## Guidelines

I will happy if you can donate/sponsor me via PayPal.Me. **[Donate Me](https://paypal.me/toviszsolt)**
To learn about the guidelines, please read the [Code of Conduct](./CODE_OF_CONDUCT.md),
[Contributing](./CONTRIBUTING.md) and [Security Policy](./SECURITY.md) documents.

## License

MIT License. Copyright (c) 2021 Zsolt Tovis
MIT License @ 2021 [Zsolt Tövis](https://github.com/toviszsolt)

If you found this project interesting, please consider supporting my open source work by
[sponsoring me on GitHub](https://github.com/sponsors/toviszsolt) /
[sponsoring me on PayPal](https://www.paypal.com/paypalme/toviszsolt) /
[give the repo a star](https://github.com/toviszsolt/react-scrollspy).

0 comments on commit 5d0d78e

Please sign in to comment.