Skip to content

Commit 953e2da

Browse files
committed
update readme and github workflows
1 parent 6943a3f commit 953e2da

File tree

3 files changed

+24
-13
lines changed

3 files changed

+24
-13
lines changed

.github/workflows/ci.yml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,7 @@ jobs:
3434
- name: Type check
3535
run: npm run typecheck
3636

37-
- name: Run tests
38-
run: npm test
3937

40-
- name: Upload coverage
41-
if: matrix.node-version == '20.x'
42-
uses: codecov/codecov-action@v4
43-
with:
44-
fail_ci_if_error: false
4538

4639
build:
4740
name: Build

.github/workflows/publish.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,6 @@ jobs:
2727
- name: Install dependencies
2828
run: npm ci
2929

30-
- name: Run tests
31-
run: npm test
32-
3330
- name: Build library
3431
run: npm run build
3532

README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
### Blazing-fast client-side image compression library for React with Web Worker support
66

7+
[![npm version](https://img.shields.io/npm/v/react-shrink.svg)](https://www.npmjs.com/package/react-shrink)
8+
[![npm downloads](https://img.shields.io/npm/dm/react-shrink.svg)](https://www.npmjs.com/package/react-shrink)
9+
[![Bundle Size](https://img.shields.io/bundlephobia/minzip/react-shrink)](https://bundlephobia.com/package/react-shrink)
710
[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
811
[![License](https://img.shields.io/badge/License-MIT-green.svg)](./LICENSE)
912

@@ -60,6 +63,11 @@ npm install heic2any
6063

6164
Compatible with: **React 16.8+**, **Next.js**, **Vite**, **Create React App**, **Remix**, **Gatsby**
6265

66+
**Verify installation:**
67+
```bash
68+
npm list react-shrink
69+
```
70+
6371
## 🚀 Quick Start
6472

6573
### React Hook (Recommended)
@@ -426,21 +434,34 @@ Contributions are welcome! Help improve React-Shrink:
426434
4. Push to the branch (`git push origin feature/amazing-feature`)
427435
5. Open a Pull Request
428436

429-
## Support
437+
## 🌟 Support
430438

431439
If React-Shrink helps your project:
432-
- ⭐ Star the repository on GitHub
440+
-[Star the repository](https://github.com/MoussaabBadla/react-shrink) on GitHub
433441
- 📢 Share with other React developers
434-
- 🐛 Report bugs and issues
442+
- 🐛 [Report bugs and issues](https://github.com/MoussaabBadla/react-shrink/issues)
435443
- 💡 Suggest new features
436444
- 📝 Improve documentation
437445

446+
## 🔗 Links
447+
448+
- 📦 [npm Package](https://www.npmjs.com/package/react-shrink)
449+
- 🐙 [GitHub Repository](https://github.com/MoussaabBadla/react-shrink)
450+
- 📖 [Documentation](https://github.com/MoussaabBadla/react-shrink#readme)
451+
- 🐛 [Issue Tracker](https://github.com/MoussaabBadla/react-shrink/issues)
452+
- 📊 [Bundle Size Analysis](https://bundlephobia.com/package/react-shrink)
453+
438454
---
439455

440456
<div align="center">
441457

442458
**[⬆ back to top](#react-shrink)**
443459

460+
Made with ❤️ for the React community by [Badla Moussaab](https://github.com/MoussaabBadla)
461+
462+
[![GitHub stars](https://img.shields.io/github/stars/MoussaabBadla/react-shrink?style=social)](https://github.com/MoussaabBadla/react-shrink)
463+
[![npm](https://img.shields.io/npm/v/react-shrink.svg)](https://www.npmjs.com/package/react-shrink)
444464

465+
**Topics:** `react` · `image-compression` · `image-optimization` · `webp` · `avif` · `typescript` · `web-workers` · `nextjs` · `vite` · `frontend` · `browser` · `upload` · `resize` · `compress` · `heic` · `jpeg` · `png` · `performance` · `optimization` · `client-side`
445466

446467
</div>

0 commit comments

Comments
 (0)