payload-plugin-newsletter 0.1.0 → 0.1.1

package/ANNOUNCEMENT.md

@@ -0,0 +1,66 @@
+# 🎉 Payload Newsletter Plugin v0.1.0 Released!
+
+We're excited to announce the first release of the Payload Newsletter Plugin - a complete newsletter management solution for Payload CMS!
+
+## 📦 Installation
+
+The plugin is now available on npm:
+
+```bash
+npm install payload-plugin-newsletter
+# or
+bun add payload-plugin-newsletter
+# or
+yarn add payload-plugin-newsletter
+```
+
+## ✨ Key Features
+
+- **📧 Complete Subscriber Management** - Ready-to-use subscriber collection with all essential fields
+- **🔐 Magic Link Authentication** - Passwordless authentication for subscribers (separate from Payload auth)
+- **📨 Email Service Integration** - Built-in support for Resend and Broadcast
+- **📅 Newsletter Scheduling** - Schedule newsletters from your articles collection
+- **⚛️ React Components** - Pre-built signup forms and preference management UI
+- **🌍 Internationalization** - Multi-language support built-in
+- **📊 Analytics Ready** - UTM tracking and signup metadata collection
+
+## 🚀 Quick Start
+
+```typescript
+import { buildConfig } from 'payload/config'
+import { newsletterPlugin } from 'payload-plugin-newsletter'
+
+export default buildConfig({
+  plugins: [
+    newsletterPlugin({
+      providers: {
+        default: 'resend',
+        resend: {
+          apiKey: process.env.RESEND_API_KEY,
+          fromAddress: 'hello@yoursite.com',
+          fromName: 'Your Newsletter',
+        },
+      },
+    }),
+  ],
+})
+```
+
+## 📚 Resources
+
+- **npm**: https://www.npmjs.com/package/payload-plugin-newsletter
+- **GitHub**: https://github.com/aniketpanjwani/payload-plugin-email-newsletter
+- **Documentation**: [README.md](https://github.com/aniketpanjwani/payload-plugin-email-newsletter#readme)
+- **Issues**: https://github.com/aniketpanjwani/payload-plugin-email-newsletter/issues
+
+## 🤝 Contributing
+
+We welcome contributions! Check out our [FEEDBACK.md](https://github.com/aniketpanjwani/payload-plugin-email-newsletter/blob/main/FEEDBACK.md) for areas where we'd love community input.
+
+## 🙏 Acknowledgments
+
+Special thanks to the Payload CMS team for creating such an extensible platform!
+
+---
+
+Made with ❤️ by [Aniket Panjwani](https://github.com/aniketpanjwani)

package/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.1] - 2025-06-15
+
+### Fixed
+- Updated README to reflect npm availability
+- Fixed package.json warnings for npm publishing
+
 ## [0.1.0] - 2025-06-15
 
 ### Added
@@ -32,4 +38,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Domain restriction options
 - Input validation and sanitization
 
-[0.1.0]: https://github.com/aniketpanjwani/payload-plugin-email-newsletter/releases/tag/v0.1.0
+[0.1.0]: https://github.com/aniketpanjwani/payload-plugin-email-newsletter/releases/tag/v0.1.0
+
+---
+
+**npm**: https://www.npmjs.com/package/payload-plugin-newsletter

package/README.md

@@ -1,5 +1,8 @@
 # Payload Newsletter Plugin
 
+[![npm version](https://badge.fury.io/js/payload-plugin-newsletter.svg)](https://www.npmjs.com/package/payload-plugin-newsletter)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 A complete newsletter management plugin for Payload CMS that provides subscriber management, magic link authentication, and email service integration out of the box.
 
 ## Features
@@ -17,23 +20,14 @@ A complete newsletter management plugin for Payload CMS that provides subscriber
 
 ### 1. Install the plugin
 
-**Note: This plugin is not yet published to npm. Install directly from GitHub:**
-
-```bash
-bun add github:aniketpanjwani/payload-plugin-email-newsletter
-# or
-npm install github:aniketpanjwani/payload-plugin-email-newsletter
-# or
-yarn add github:aniketpanjwani/payload-plugin-email-newsletter
-# or
-pnpm add github:aniketpanjwani/payload-plugin-email-newsletter
-```
-
-Once published to npm, you'll be able to install with:
 ```bash
 bun add payload-plugin-newsletter
 # or
 npm install payload-plugin-newsletter
+# or
+yarn add payload-plugin-newsletter
+# or
+pnpm add payload-plugin-newsletter
 ```
 
 ### 2. Add to your Payload config

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payload-plugin-newsletter",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Complete newsletter management plugin for Payload CMS with subscriber management, magic link authentication, and email service integration",
   "type": "module",
   "main": "./src/index.ts",
@@ -43,30 +43,7 @@
     "*.md"
   ],
   "publishConfig": {
-    "main": "./dist/index.js",
-    "types": "./dist/index.d.ts",
-    "exports": {
-      ".": {
-        "import": "./dist/index.js",
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      },
-      "./client": {
-        "import": "./dist/exports/client.js",
-        "types": "./dist/exports/client.d.ts",
-        "default": "./dist/exports/client.js"
-      },
-      "./types": {
-        "import": "./dist/exports/types.js",
-        "types": "./dist/exports/types.d.ts",
-        "default": "./dist/exports/types.js"
-      },
-      "./components": {
-        "import": "./dist/exports/components.js",
-        "types": "./dist/exports/components.d.ts",
-        "default": "./dist/exports/components.js"
-      }
-    }
+    "access": "public"
   },
   "keywords": [
     "payload",
@@ -85,7 +62,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/aniketpanjwani/payload-plugin-email-newsletter"
+    "url": "git+https://github.com/aniketpanjwani/payload-plugin-email-newsletter.git"
   },
   "bugs": {
     "url": "https://github.com/aniketpanjwani/payload-plugin-email-newsletter/issues"