From 317af610ab112b530bbbbf97777cdcfce5a78df9 Mon Sep 17 00:00:00 2001
From: AVGVSTVS96 <122117267+AVGVSTVS96@users.noreply.github.com>
Date: Sun, 4 Aug 2024 23:13:21 -0400
Subject: [PATCH] chore(playground):update readme

---
 playground/README.md | 43 +++++++++++++++++++------------------------
 1 file changed, 19 insertions(+), 24 deletions(-)

diff --git a/playground/README.md b/playground/README.md
index e1cdc89..90e5a1d 100644
--- a/playground/README.md
+++ b/playground/README.md
@@ -1,30 +1,25 @@
-# React + TypeScript + Vite
+# react-shiki-example
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+## Syntax highlighter component for react using shiki
 
-Currently, two official plugins are available:
+### Usage
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
-
-## Expanding the ESLint configuration
-
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
-
-- Configure the top-level `parserOptions` property like this:
-
-```js
-export default {
-  // other rules...
-  parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-    project: ['./tsconfig.json', './tsconfig.node.json', './tsconfig.app.json'],
-    tsconfigRootDir: __dirname,
-  },
+```tsx
+function AyuDark() {
+  return (
+    <ShikiHighlighter language="jsx" theme="ayu-dark">
+      {code.trim()}
+    </ShikiHighlighter>
+  );
 }
 ```
+The ShikiHighlighter is imported in your project and used as a component, with code to be highlighted passed as children.
+
+Shiki handles dynamically imports only the languages and themes used on the page.
+
+The component accepts several props in addition to language and theme:
 
-- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
-- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
+- `showLanguage: boolean` - Shows the language name in the top right corner of the code block.
+- `style: object` - Style object to be passed to the component.
+- `as: string` - The component to be rendered. Defaults to 'pre'.
+- `className: string` - Class name to be passed to the component.
\ No newline at end of file