parallax.css/readme.md

Pure css library for the parallax effect

# parallax.css

> pure css parallax in one file

[![npm][npm-version-image]][npm-url]
[![license][license-image]][license-url]
[![npm][npm-size-image]][npm-url]
[![jsDelivr][jsDelivr-image]][jsDelivr-url]
[![npm][npm-downloads-image]][npm-url]
[![GitHub Repo stars][github-stars-image]][github-url]

<br>

## [Official documentation page](https://matyanson.github.io/parallax.css)
<br>

## Installation

#### NPM
```sh
npm install parallax.css
```
#### YARN
```sh
yarn add parallax.css
```

#### CDN

[yarnpkg](https://yarnpkg.com/en/package/parallax.css) |
[jsdelivr](https://www.jsdelivr.com/package/npm/parallax.css) |
[unpkg](https://unpkg.com/parallax.css)


#### Download

[source](https://raw.githubusercontent.com/Matyanson/parallax.css/main/parallax.css) |
[minified](https://raw.githubusercontent.com/Matyanson/parallax.css/main/parallax.min.css) |
[jsdelivr](https://cdn.jsdelivr.net/npm/parallax.css)

</br>

## Usage

#### Module
```html
<link rel="stylesheet" href="node_modules/parallax.css/parallax.css">
```
or
```css
@import 'node_modules/parallax.css/parallax.css';
```
#### CDN
```html
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/parallax.css">
```
or
```css
@import url(https://cdn.jsdelivr.net/npm/parallax.css);
```

## Getting started

You can find the Parallax.css documentation on [github-pages](https://matyanson.github.io/parallax.css).

<!--- links for badges -->
[npm-version-image]: https://img.shields.io/npm/v/parallax.css.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/parallax.css
[license-image]: https://img.shields.io/npm/l/parallax.css.svg?style=flat-square
[license-url]: license.md
[npm-size-image]: https://img.shields.io/bundlephobia/min/parallax.css?style=flat-square
[jsDelivr-image]: https://data.jsdelivr.com/v1/package/npm/parallax.css/badge
[jsDelivr-url]: https://www.jsdelivr.com/package/npm/parallax.css
[npm-downloads-image]: https://img.shields.io/npm/dt/parallax.css?style=flat-square
[github-stars-image]: https://img.shields.io/github/stars/matyanson/parallax.css?style=social
[github-url]: https://github.com/Matyanson/parallax.css