diff --git a/package/README.md b/package/README.md index 4a4c066..8c09670 100644 --- a/package/README.md +++ b/package/README.md @@ -13,6 +13,25 @@ A CSS-only skeleton loader that supports syncing multiple elements' loading indi npm install sync-skeleton ``` +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/skeleton.css' +``` + +Or via HTML: + +```html + +``` + +Then, add the `loading-skeleton` class to any element you want to have the skeleton loader applied to. + +```html +
+``` + ## 📐 CSS Variables for customising ### 🎨 Styling / Design;