pop-emojis 0.0.0 → 0.0.1

package/README.md

@@ -1,73 +1,100 @@
-# React + TypeScript + Vite
+# pop-emojis 🎉
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+A tiny, opinionated React component that creates smooth emoji pop animations on click — built on top of Framer Motion.
 
-Currently, two official plugins are available:
+Perfect for reactions, likes, feedback buttons, and fun micro-interactions with **zero animation setup**.
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+---
 
-## React Compiler
+## ✨ Features
 
-The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
+-  **One-line usage** — Add emoji pops in seconds
+-  **Built on Framer Motion** — Smooth, physics-based animations
+-  **Sensible defaults** — Works great out of the box
+- 📦 **Zero boilerplate** — No animation code required
+- 🔒 **Fully typed** — Complete TypeScript support
+- ⚛️ **React 17+** — Compatible with modern React
 
-## Expanding the ESLint configuration
+---
 
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
+## 📦 Installation
 
-```js
-export default defineConfig([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
+```bash
+npm install pop-emojis framer-motion
+```
+
+> **Note:** `framer-motion` is a peer dependency and must be installed separately.
+
+---
+
+## 🚀 Usage
+
+### Basic Example
+
+```tsx
+import { EmojiPop } from "pop-emojis"
+
+export default function App() {
+  return (
+    <div style={{ display: "flex", justifyContent: "center", marginTop: 100 }}>
+      <EmojiPop emoji="🫡" />
+    </div>
+  )
+}
+```
+
+**What happens?**
 
-      // Remove tseslint.configs.recommended and replace with this
-      tseslint.configs.recommendedTypeChecked,
-      // Alternatively, use this for stricter rules
-      tseslint.configs.strictTypeChecked,
-      // Optionally, add this for stylistic rules
-      tseslint.configs.stylisticTypeChecked,
+1. You see 🫡
+2. You click 🫡
+3. Multiple 🫡 emojis pop out with smooth animations
 
-      // Other configs...
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
+### Custom Count
+
+```tsx
+<EmojiPop emoji="❤️" count={10} />
 ```
 
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
-
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
-
-export default defineConfig([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-      // Enable lint rules for React
-      reactX.configs['recommended-typescript'],
-      // Enable lint rules for React DOM
-      reactDom.configs.recommended,
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
+### Different Emojis
+
+```tsx
+<div style={{ display: "flex", gap: "1rem" }}>
+  <EmojiPop emoji="🎉" />
+  <EmojiPop emoji="👍" />
+  <EmojiPop emoji="🔥" />
+  <EmojiPop emoji="⭐" />
+</div>
 ```
+
+---
+
+## ⚙️ Props
+
+| Prop    | Type     | Default | Description                            |
+|---------|----------|---------|----------------------------------------|
+| `emoji` | `string` | `"🫡"`  | Emoji used for both button & animation |
+| `count` | `number` | `6`     | Number of emojis per click             |
+
+---
+
+## 🤔 Why This Library?
+
+Yes, you can use Framer Motion directly.
+
+This library exists to:
+
+✅ **Remove repetitive animation code** — Don't write the same pop logic over and over
+
+✅ **Provide a ready-made reaction interaction** — Common UX pattern, pre-built
+
+✅ **Keep animation logic out of your app** — Focus on features, not micro-interactions
+
+Think of it as a **pre-built micro-interaction**, not an animation engine.
+
+---
+
+
+
+## 🤝 Contributing
+
+Issues and pull requests are welcome! Feel free to open an issue if you find a bug or have a feature request.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "pop-emojis",
   "private": false,
-  "version": "0.0.0",
+  "version": "0.0.1",
   "type": "module",
   "author": "MahindraGamni",
   "description": "A React component for animated emoji pop effects",