Skip to content

Commit 50b50ae

Browse files
committed
chore: update README
1 parent a1cb84f commit 50b50ae

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
# auto-skeleton-react
22

3+
![npm version](https://img.shields.io/npm/v/auto-skeleton-react)
4+
![npm downloads](https://img.shields.io/npm/dm/auto-skeleton-react)
5+
![license](https://img.shields.io/npm/l/auto-skeleton-react)
6+
37
Auto-generate skeleton loading screens from your existing React DOM structure. Zero manual skeleton creation for 70-80% of use cases.
48

9+
**[Live Demo](https://autoskeleton.shanukj.me)** | **[Documentation](https://autoskeleton.shanukj.me/docs)**
10+
511
## Installation
612

713
```bash
@@ -11,6 +17,7 @@ npm install auto-skeleton-react
1117
## Usage
1218

1319
```tsx
20+
import { useState } from 'react';
1421
import { AutoSkeleton } from 'auto-skeleton-react';
1522

1623
function MyComponent() {
@@ -125,6 +132,10 @@ src/
125132
- Virtualized tables or infinite scrollers
126133
- Performance-critical views with frequent loading
127134

135+
## Contributing
136+
137+
Found a bug or have a feature request? [Open an issue](https://github.com/ShanukJ/auto-skeleton/issues) on GitHub.
138+
128139
## License
129140

130141
MIT

0 commit comments

Comments
 (0)