README.md 1.59 KB
Newer Older
Gaëtan Renaudeau's avatar
Gaëtan Renaudeau committed
1
## **IMPORTANT: v2.0.0 is currently unstable. Please use [v1.3.0](https://github.com/ProjectSeptemberInc/gl-react-native/tree/v1.3.0)**
Gaëtan Renaudeau's avatar
Gaëtan Renaudeau committed
2

Gaëtan Renaudeau's avatar
Gaëtan Renaudeau committed
3
**[Gitbook documentation](http://projectseptemberinc.gitbooks.io/gl-react/content/) / [Github](https://github.com/ProjectSeptemberInc/gl-react-native/) / [gl-react](https://github.com/ProjectSeptemberInc/gl-react/)** / [#gl-react on reactiflux](https://discordapp.com/channels/102860784329052160/106102146109325312)
Gaëtan Renaudeau's avatar
Gaëtan Renaudeau committed
4

Gaëtan Renaudeau's avatar
Gaëtan Renaudeau committed
5
# <img width="32" alt="icon" src="https://cloud.githubusercontent.com/assets/211411/9813786/eacfcc24-5888-11e5-8f9b-5a907a2cbb21.png"> gl-react-native ![](https://img.shields.io/badge/react--native-%3E=%200.16.0-05F561.svg)
6

Gaëtan Renaudeau's avatar
Gaëtan Renaudeau committed
7
OpenGL bindings for React Native to implement complex effects over images and components, in the descriptive VDOM paradigm.
8

Gaëtan Renaudeau's avatar
Gaëtan Renaudeau committed
9
**`gl-react-native` is an implementation of `gl-react` for `react-native`. Please [read the main gl-react README](https://github.com/ProjectSeptemberInc/gl-react/) for more information.**
10

11
[![](https://github.com/ProjectSeptemberInc/gl-react-native/raw/master/docs/simple.gif)](./Examples/Simple)[![](https://github.com/ProjectSeptemberInc/gl-react-native/raw/master/docs/advancedeffects.gif)](./Examples/AdvancedEffects)
Gaëtan Renaudeau's avatar
Gaëtan Renaudeau committed
12

13
## Documentation
Gaëtan Renaudeau's avatar
Gaëtan Renaudeau committed
14

15
[**Gitbook**](http://projectseptemberinc.gitbooks.io/gl-react/content/)
16

Gaëtan Renaudeau's avatar
Gaëtan Renaudeau committed
17 18
## Installation

19
a few steps are required to install `gl-react-native`:
Gaëtan Renaudeau's avatar
Gaëtan Renaudeau committed
20

Gaëtan Renaudeau's avatar
typo  
Gaëtan Renaudeau committed
21
**Install the dependency to your React Native application:**
Gaëtan Renaudeau's avatar
Gaëtan Renaudeau committed
22 23 24 25 26

```
npm i --save gl-react-native
```

27
**Configure your React Native Application:**
Gaëtan Renaudeau's avatar
Gaëtan Renaudeau committed
28

29
![](https://github.com/ProjectSeptemberInc/gl-react-native/raw/master/docs/install-steps.png)