metaforge-seo/README.md

Lightweight SEO metadata manager for React + Vite apps.

# 📊 MetaForge SEO

Lightweight, modular, and blazing-fast meta tag generator for modern web apps.

> Perfect for React SPAs, landing pages, marketing sites, or any SEO-conscious frontend.
---


## Features

-  Dynamic `<meta>` tags
-  Open Graph & Twitter Cards
-  JSON-LD structured data support
-  `noindex`, `nofollow` control
-  No external dependencies
-  Works in any React app (CRA, Vite, etc.)

---


## Installation

```bash
npm install metaforge-seo
# or
yarn add metaforge-seo
```

---


## Usage

```jsx
import React from "react";
import SEO from "metaforge-seo";

export default function HomePage() {
  return (
    <>
      <SEO
        title="Home | My App"
        description="Welcome to my awesome web app!"
        keywords="SEO, React, web, optimization"
        canonicalUrl="https://mywebsite.com/"
        ogTitle="My App Homepage"
        ogDescription="This is the description for social sharing."
        ogImage="https://mywebsite.com/preview.png"
        ogUrl="https://mywebsite.com/"
        twitterCard="summary_large_image"
        twitterSite="@yourhandle"
        twitterCreator="@yourhandle"
        noindex={false}
        nofollow={false}
        jsonLd={{
          context: "https://schema.org",
          type: "WebSite",
          data: {
            name: "My Website",
            url: "https://mywebsite.com",
          },
        }}
      />
      <main>Your content here...</main>
    </>
  );
}
```

---


## Props Reference

| Prop             | Type      | Description                                             |
| ---------------- | --------- | ------------------------------------------------------- |
| `title`          | `string`  | Page title (`<title>`)                                  |
| `description`    | `string`  | Meta description                                        |
| `keywords`       | `string`  | SEO keywords                                            |
| `canonicalUrl`   | `string`  | Canonical URL for search engines                        |
| `lang`           | `string`  | Document language (default: `en`)                       |
| `ogTitle`        | `string`  | Open Graph title                                        |
| `ogDescription`  | `string`  | Open Graph description                                  |
| `ogImage`        | `string`  | Open Graph image URL                                    |
| `ogUrl`          | `string`  | Open Graph page URL                                     |
| `twitterCard`    | `string`  | Twitter card type (default: `summary_large_image`)      |
| `twitterSite`    | `string`  | Twitter site handle                                     |
| `twitterCreator` | `string`  | Twitter creator handle                                  |
| `noindex`        | `boolean` | Prevent search engines from indexing the page           |
| `nofollow`       | `boolean` | Prevent search engines from following links on the page |
| `jsonLd`         | `object`  | JSON-LD structured data object                          |

---


## Why MetaForge SEO?

Unlike heavy frameworks or complex SEO libraries, MetaForge SEO:

- Works with any setup — no config lock-in
- Provides full control over the head tags
- Is dead-simple to integrate and extend

---


## Development

```bash
git clone https://github.com/ManoharBari/metaforge-seo-npm-package.git
cd metaforge-seo-npm-package
npm install
npm run build
```

---


## License

MIT © [Manohar Kale](https://github.com/manoharbari)

---


## 🌐 Useful Links

- [Open Graph Tags Reference](https://ogp.me/)
- [JSON-LD Generator](https://www.google.com/webmasters/markup-helper/)
- [Twitter Card Validator](https://cards-dev.twitter.com/validator)