diff --git a/README.md b/README.md index 511999b489..b8bc67be5e 100644 --- a/README.md +++ b/README.md @@ -23,8 +23,15 @@ For detailed information on library development, building, testing, and contribu ## Graphite Skia has two backends: Ganesh and Graphite. Ganesh is the default backend. -If you want to experiment with Graphite, you can enable it by building Skia with `SK_GRAPHITE=1 yarn build-skia`. +Graphite is available as an experimental preview in the `@next` distribution channel: + +```sh +yarn add @shopify/react-native-skia@next +``` + +**This is highly experimental and not recommended for production use.** Skia Graphite requires Android API Level 26 or above. +If you prefer to build Skia yourself with Graphite support, you can do so with `SK_GRAPHITE=1 yarn build-skia`. React Native Skia automatically detects Graphite via a marker file included in the prebuilt libs. diff --git a/apps/docs/docs/getting-started/installation.md b/apps/docs/docs/getting-started/installation.md index ac0c08180d..d11f7d223a 100644 --- a/apps/docs/docs/getting-started/installation.md +++ b/apps/docs/docs/getting-started/installation.md @@ -132,6 +132,20 @@ The `jestEnv.js` will load CanvasKit for you and `jestEnv.js` mocks React Native You can also have a look at the [example app](https://github.com/Shopify/react-native-skia/tree/main/apps/example) to see how Jest tests are enabled there. +## Graphite (Experimental) + +Skia has two backends: Ganesh (default) and Graphite. An experimental preview of Graphite is available in the `@next` distribution channel: + +```sh +yarn add @shopify/react-native-skia@next +``` + +:::warning + +Graphite support is highly experimental. Skia Graphite requires Android API Level 26 or above. + +::: + ## Playground We have example projects you can play with [here](https://github.com/Shopify/react-native-skia/tree/main/apps).