@boomitra/carbon-calculator 0.2.13 → 0.2.15

package/README.md

@@ -1,2 +1,62 @@
-# carbon-calculator
-Frontend Repo
+# Carbon Calculator
+
+A versatile Carbon Calculator available as a React package.
+
+## 📦 Usage as a React Package
+
+If you have an existing React application, you can install and use the component directly.
+
+### 1. Installation
+
+```bash
+npm install @boomitra/carbon-calculator
+```
+
+### 2. Integration
+
+Import the component and its styles in your application.  
+**Note:** You must pass the `host` prop to specify the destination URL (e.g., your checkout page) where the user will be redirected when clicking the "Offset" button.
+
+```jsx
+import React from "react";
+import CarbonCalculator from "@boomitra/carbon-calculator";
+import "@boomitra/carbon-calculator/style.css"; // Don't forget the styles!
+
+function App() {
+  const host = "https://your-website.com/checkout"; // URL for redirection
+
+  return (
+    <div className="App">
+      <h1>Carbon Footprint Calculator</h1>
+      <CarbonCalculator host={host} />
+    </div>
+  );
+}
+
+export default App;
+```
+
+
+
+## 🛠️ Development
+
+### Setup
+
+```bash
+npm install
+```
+
+### Run Locally
+
+```bash
+npm start
+```
+
+Runs the app in development mode at `http://localhost:5173`.
+
+### Build Commands
+
+- **Build Package**: `npm run build`
+  - Outputs to `dist-package/`
+  - Used for publishing to npm (ESM + CommonJS).
+