readme

KurtGokhan · Oct 1, 2024 · bc23a08 · bc23a08
1 parent f6237a7
commit bc23a08
Show file tree

Hide file tree

Showing 23 changed files with 38 additions and 35 deletions.
diff --git a/.vscode/react-on.code-workspace → .vscode/react-clarify.code-workspace b/.vscode/react-on.code-workspace → .vscode/react-clarify.code-workspace
diff --git a/README.md b/README.md
@@ -4,6 +4,41 @@
 
 # React Clarify
 
-React Clarify is an instruction library for React. It helps you to write declarative user tracking and analytics code. It uses React Context to declare the tracked data.
+**React Clarify** allows you to add analytics tracking to your React components declaratively, keeping your codebase clean and focused on the core functionality of your app.
 
-[Visit the docs →](https://gkurt.com/react-clarify/)
+## Features
+
+- Declarative analytics integration
+- No need to clutter your components with tracking logic
+- Easy to configure and extend
+- Supports any analytics provider
+- Works seamlessly with React hooks and lifecycle methods
+- Strong Typescript support
+
+## Installation
+
+Install the package via npm or yarn:
+
+```bash
+npm install react-clarify
+# or
+yarn add react-clarify
+```
+
+## Documentation
+
+For detailed documentation, setup instructions, and API references, visit the [official documentation](http://gkurt.com/react-clarify/).
+
+## Why use React Clarify?
+
+- **Simplify your codebase**: Remove the burden of manually adding analytics code throughout your components.
+- **Declarative and maintainable**: Track analytics events as part of your component’s markup, keeping everything readable and maintainable.
+- **Flexible**: Easily integrate with multiple analytics providers or create custom ones.
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request to improve the library.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/react-on/.gitignore → packages/react-clarify/.gitignore b/packages/react-on/.gitignore → packages/react-clarify/.gitignore
diff --git a/packages/react-on/package.json → packages/react-clarify/package.json b/packages/react-on/package.json → packages/react-clarify/package.json
diff --git a/packages/react-on/src/default.ts → packages/react-clarify/src/default.ts b/packages/react-on/src/default.ts → packages/react-clarify/src/default.ts
diff --git a/...s/react-on/src/hooks/use-combined-refs.ts → ...ct-clarify/src/hooks/use-combined-refs.ts b/...s/react-on/src/hooks/use-combined-refs.ts → ...ct-clarify/src/hooks/use-combined-refs.ts
diff --git a/...react-on/src/hooks/use-stable-callback.ts → ...-clarify/src/hooks/use-stable-callback.ts b/...react-on/src/hooks/use-stable-callback.ts → ...-clarify/src/hooks/use-stable-callback.ts
diff --git a/packages/react-on/src/hooks/use-stable.ts → ...ges/react-clarify/src/hooks/use-stable.ts b/packages/react-on/src/hooks/use-stable.ts → ...ges/react-clarify/src/hooks/use-stable.ts
diff --git a/packages/react-on/src/index.ts → packages/react-clarify/src/index.ts b/packages/react-on/src/index.ts → packages/react-clarify/src/index.ts
diff --git a/packages/react-on/src/lib/creator.ts → packages/react-clarify/src/lib/creator.ts b/packages/react-on/src/lib/creator.ts → packages/react-clarify/src/lib/creator.ts
diff --git a/packages/react-on/src/lib/handlers.tsx → packages/react-clarify/src/lib/handlers.tsx b/packages/react-on/src/lib/handlers.tsx → packages/react-clarify/src/lib/handlers.tsx
diff --git a/packages/react-on/src/lib/provider.tsx → packages/react-clarify/src/lib/provider.tsx b/packages/react-on/src/lib/provider.tsx → packages/react-clarify/src/lib/provider.tsx
diff --git a/packages/react-on/src/lib/track-callback.tsx → .../react-clarify/src/lib/track-callback.tsx b/packages/react-on/src/lib/track-callback.tsx → .../react-clarify/src/lib/track-callback.tsx
diff --git a/packages/react-on/src/lib/track-event.tsx → ...ges/react-clarify/src/lib/track-event.tsx b/packages/react-on/src/lib/track-event.tsx → ...ges/react-clarify/src/lib/track-event.tsx
diff --git a/packages/react-on/src/middlewares/index.tsx → ...s/react-clarify/src/middlewares/index.tsx b/packages/react-on/src/middlewares/index.tsx → ...s/react-clarify/src/middlewares/index.tsx
diff --git a/packages/react-on/src/types.ts → packages/react-clarify/src/types.ts b/packages/react-on/src/types.ts → packages/react-clarify/src/types.ts
diff --git a/packages/react-on/tests/base.spec.tsx → packages/react-clarify/tests/base.spec.tsx b/packages/react-on/tests/base.spec.tsx → packages/react-clarify/tests/base.spec.tsx
diff --git a/packages/react-on/tests/utils.tsx → packages/react-clarify/tests/utils.tsx b/packages/react-on/tests/utils.tsx → packages/react-clarify/tests/utils.tsx
diff --git a/packages/react-on/tsconfig.app.json → packages/react-clarify/tsconfig.app.json b/packages/react-on/tsconfig.app.json → packages/react-clarify/tsconfig.app.json
diff --git a/packages/react-on/tsconfig.json → packages/react-clarify/tsconfig.json b/packages/react-on/tsconfig.json → packages/react-clarify/tsconfig.json
diff --git a/packages/react-on/tsconfig.spec.json → packages/react-clarify/tsconfig.spec.json b/packages/react-on/tsconfig.spec.json → packages/react-clarify/tsconfig.spec.json
diff --git a/packages/react-on/vite.config.ts → packages/react-clarify/vite.config.ts b/packages/react-on/vite.config.ts → packages/react-clarify/vite.config.ts