Skip to content

Commit

Permalink
docs: improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
avisek committed Feb 9, 2024
1 parent d37b60a commit bfa6fe8
Showing 1 changed file with 1 addition and 6 deletions.
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ ScrollSizeObserver is a lightweight JavaScript library that provides a simple an
- **Flexible Configuration**: Offers options to observe horizontal and/or vertical scroll sizes based on requirements.
- **Efficient Observations**: Utilizes modern browser APIs to efficiently track changes without impacting performance.
- **Cross-Browser Compatibility**: Compatible with major modern browsers, ensuring consistent behavior across different environments.
- **TypeScript Support**: Provides full support for TypeScript, enabling type-checking and enhanced development experience.
- **Lightweight**: Zero-dependency minimal footprint ensures fast loading times and optimal performance.

## Demo
Expand All @@ -22,12 +23,6 @@ You can install ScrollSizeObserver via npm:
npm install scroll-size-observer
```

Alternatively, you can include it directly in your HTML:

```html
<script src="https://cdn.jsdelivr.net/npm/scroll-size-observer/dist/scroll-size-observer.min.js"></script>
```

## Usage

```javascript
Expand Down

0 comments on commit bfa6fe8

Please sign in to comment.