From 56dff70878636d5fdac48b618e670452c26946a6 Mon Sep 17 00:00:00 2001 From: Corbin Crutchley Date: Fri, 19 Sep 2025 06:26:00 -0700 Subject: [PATCH] docs: update docs to reflect new API --- packages/react/README.md | 16 +++++++--------- packages/vue/README.md | 14 ++++++++------ 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/packages/react/README.md b/packages/react/README.md index 314ad41..7a6cec9 100644 --- a/packages/react/README.md +++ b/packages/react/README.md @@ -6,19 +6,17 @@ A modern skeleton loader that supports syncing multiple elements' loading indica ## Installation -```tsx -import { useSkeletonSetup } from "@sync-skeleton/react" +The only prerequisite to using this package is the CSS file. Import it in your project via TypeScript: + +```typescript // Required for usage import "@sync-skeleton/core/skeleton.css" +``` -export function App() { - // Required in the root component for usage - useSkeletonSetup(); +Or via HTML: - return ( - // ... - ) -} +```html + ``` ## Usage diff --git a/packages/vue/README.md b/packages/vue/README.md index 98cfd41..0fd8ffc 100644 --- a/packages/vue/README.md +++ b/packages/vue/README.md @@ -6,15 +6,17 @@ A modern skeleton loader that supports syncing multiple elements' loading indica ## Installation -```vue - +Or via HTML: + +```html + ``` ## Usage -- 2.51.2