rofrischmann/fela

View on GitHub
packages/preact-fela/README.md

Summary

Maintainability
Test Coverage
# Preact Fela

<img alt="npm version" src="https://badge.fury.io/js/preact-fela.svg"> <img alt="npm downloads" src="https://img.shields.io/npm/dm/preact-fela.svg"> <a href="https://bundlephobia.com/result?p=preact-fela@latest"><img alt="Bundlephobia" src="https://img.shields.io/bundlephobia/minzip/preact-fela.svg"></a>

Official [Preact](https://github.com/Preactjs/Preact) bindings for Fela.

This package only includes Preact bindings for [Fela](http://github.com/robinweser/fela).<br>
It assumes you already know about Fela and how to use it.

## Installation
```sh
yarn add preact-fela
```
You may alternatively use `npm i --save preact-fela`.


## Usage
For more information and best practices on how to effectively use this package, please check out the main [Fela Documention - Usage with Peact](http://fela.js.org/docs/guides/UsageWithPreact.html). You will find some useful examples and a basic introduction on how to use Fela with Peact.<br>
Checkout the [API Reference - Bindings](http://fela.js.org/docs/API.html#bindings) for further technical information on how the React/Preact/Inferno bindings work.

## License
Fela is licensed under the [MIT License](http://opensource.org/licenses/MIT).<br>
Documentation is licensed under [Creative Commons License](http://creativecommons.org/licenses/by/4.0/).<br>
Created with ♥ by [@robinweser](http://weser.io) and all the great contributors.