docs(Skeleton): update README (#909)

gravity-ui · Aug 17, 2023 · 8e36280 · 8e36280
1 parent 9c6f5a7
commit 8e36280
Showing 1 changed file with 15 additions and 6 deletions.
diff --git a/src/components/Skeleton/README.md b/src/components/Skeleton/README.md
@@ -1,9 +1,18 @@
-## Skeleton
+<!--GITHUB_BLOCK-->
 
-Component for illusion of fast loading.
+# Skeleton
 
-### PropTypes
+<!--/GITHUB_BLOCK-->
 
-| Property  | Type     | Required | Default | Description                                 |
-| :-------- | :------- | :------- | :------ | :------------------------------------------ |
-| className | `String` |          |         | Class name to customize size component size |
+```tsx
+import {Skeleton} from '@gravity-ui/uikit';
+```
+
+The Skeleton component displays a placeholder preview of your content before the data gets loaded to reduce load-time frustration.
+
+## Properties
+
+| Property  | Description                                            | Default |
+| :-------- | :----------------------------------------------------- | :------ |
+| style     | Custom CSS properties for root element `CSSProperties` |         |
+| className | Custom CSS class for root element `string`             |         |