@frsource/tiny-carousel-core/README.md

Core module for @frsource/tiny-carousel, based on CSS scroll snap feature 🚀

<p align="center">
  <a href="https://www.npmjs.com/package/@frsource/tiny-carousel-core">
    <img src="https://img.shields.io/npm/v/@frsource/tiny-carousel-core" alt="NPM version badge">
  </a>
  <a href="https://bundlephobia.com/result?p=@frsource/tiny-carousel-core" title="Visit bundlephobia for more details!">
    <img src="https://img.shields.io/bundlephobia/minzip/@frsource/tiny-carousel-core" alt="Core bundle size badge. Data from bundlephobia.com">
  </a>
  <a href="https://bundlephobia.com/result?p=@frsource/tiny-carousel-core">
    <img src="https://badgen.net/bundlephobia/tree-shaking/@frsource/tiny-carousel-core" alt="Tree shaking supported">
  </a>
  <a href="https://github.com/semantic-release/semantic-release">
    <img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-relase badge">
  </a>
  <a href="https://github.com/FRSOURCE/tiny-carousel/blob/master/LICENSE">
    <img src="https://img.shields.io/github/license/FRSOURCE/tiny-carousel" alt="license MIT badge">
  </a>
</p>

<h1 align="center">Core module for @frsource/tiny-carousel, based on CSS scroll snap feature 🚀</h1>

<p align="center">
  <a href="https://www.frsource.org/tiny-carousel/guide/usage/#core">Usage guide</a>
  ·
  <a href="https://www.frsource.org/tiny-carousel/api-reference/core/">API Reference</a>
  ·
  <a href="https://www.frsource.org/tiny-carousel/contribution/">Contribution</a>
  ·
  <a href="https://github.com/FRSOURCE/tiny-carousel/issues">File an Issue</a>
  ·
  <a href="https://github.com/FRSOURCE/tiny-carousel/discussions">Have a question or an idea?</a>
  <br>
</p>

<p align="center">
  <br>
  <i>The main package of the Tiny Carousel <a href="https://www.frsource.org/tiny-carousel/ecosystem/">ecosystem</a> which gives the most basic carousel API.
    <br>Takes advantage of <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Scroll_Snap">CSS snap points</a>.</i>
  <br>
  <br>
</p>


<p align="center">
  <img src="https://github.com/FRSOURCE/tiny-carousel/blob/master/src/logo.png" alt="Tiny carousel library logo" height="120px"/>
  <br>
  <a href="https://www.frsource.org/tiny-carousel"><strong>www.frsource.org/tiny-carousel</strong></a>
  <br>
  <br>
</p>


## Documentation

For docs, please visit [frsource.org/tiny-carousel](https://www.frsource.org/tiny-carousel/)

- [Getting Started](https://www.frsource.org/tiny-carousel/guide/usage/#core)
- [API Reference](https://www.frsource.org/tiny-carousel/api-reference/core/)
- [Ecosystem & plugins](https://www.frsource.org/tiny-carousel/ecosystem/)

## Questions

Don’t hesitate to ask a question directly on the [discussions board](https://github.com/FRSOURCE/tiny-carousel/discussions)!

## Changelog

Changes for every release are documented in the [release notes](https://github.com/FRSOURCE/tiny-carousel/releases) and [CHANGELOG](https://github.com/FRSOURCE/tiny-carousel/blob/master/packages/core/CHANGELOG.md).

## License

[MIT](https://opensource.org/licenses/MIT)

Copyright (c) 2020-present, Jakub FRS Freisler, FRSOURCE