From 9786402e5f7c90fad1c25dd348fe6c717cee6f70 Mon Sep 17 00:00:00 2001 From: William Candillon Date: Fri, 17 Dec 2021 11:15:02 +0100 Subject: [PATCH 1/4] :books: --- README.md | 9 +++++++-- docs/docs/getting-started/installation.md | 15 ++++++++++++-- docs/src/pages/index.tsx | 24 ++++++++++++++++++++++- 3 files changed, 43 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index fb4939266d..d25fb9a56a 100644 --- a/README.md +++ b/README.md @@ -4,19 +4,24 @@ https://shopify.github.io/react-native-skia React Native Skia brings the Skia Graphics Library to React Native. Skia serves as the graphics engine for Google Chrome and Chrome OS, Android, Flutter, Mozilla Firefox and, Firefox OS, and many other products. +* This is an alpha release. Use with caution. * + ## Installation React Native Skia brings the [Skia Graphics Library](https://skia.org/) to React Native. Skia serves as the graphics engine for Google Chrome and Chrome OS, Android, Flutter, Mozilla Firefox and, Firefox OS, and many other products. +When reading these lines, the package is not yet available on npm. +Use the link below to install the package. + ```sh -$ yarn add @shopify/react-native-skia +$ yarn add URL ``` Or using npm: ```sh -$ npm install @shopify/react-native-skia +$ npm install URL ``` ### iOS diff --git a/docs/docs/getting-started/installation.md b/docs/docs/getting-started/installation.md index 41e3247179..08e60fb3ed 100644 --- a/docs/docs/getting-started/installation.md +++ b/docs/docs/getting-started/installation.md @@ -8,14 +8,25 @@ slug: /getting-started/installation React Native Skia brings the [Skia Graphics Library](https://skia.org/) to React Native. Skia serves as the graphics engine for Google Chrome and Chrome OS, Android, Flutter, Mozilla Firefox and, Firefox OS, and many other products. + +:::warning + +This is an alpha release. +Use with caution. + +::: + +When reading these lines, the package is not yet available on npm. +Use the link below to install the package. + ```sh -$ yarn add @shopify/react-native-skia +$ yarn add URL ``` Or using npm: ```sh -$ npm add @shopify/react-native-skia +$ npm install URL ``` ## iOS diff --git a/docs/src/pages/index.tsx b/docs/src/pages/index.tsx index 84d4eb17ab..ce78f35033 100644 --- a/docs/src/pages/index.tsx +++ b/docs/src/pages/index.tsx @@ -35,7 +35,29 @@ export default function Home() { description="High Performance 2D Graphics" > -
+
+
+