pressclaw 0.2.0 → 0.3.0

package/README.md

@@ -1,67 +1,74 @@
-# PressClaw
+<p align="center">
+  <h1 align="center">PressClaw</h1>
+  <p align="center"><strong>Your AI agent's writing pipeline. Think → Draft → Publish.</strong></p>
+  <p align="center">
+    <a href="https://www.npmjs.com/package/pressclaw"><img src="https://img.shields.io/npm/v/pressclaw.svg" alt="npm version"></a>
+    <a href="https://github.com/niklasbabel/pressclaw/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/pressclaw.svg" alt="license"></a>
+  </p>
+</p>
 
-**Turn conversations into published content.**
+PressClaw is an [OpenClaw](https://openclaw.ai) plugin that turns your conversations into published content. Your AI agent handles the heavy lifting — drafting, rewriting, testing against audiences, adapting for platforms — while you stay in control of what goes public.
 
-An [OpenClaw](https://github.com/openclaw/openclaw) plugin that gives your AI agent a complete writing pipeline — from rough idea to published blog post, with style learning, audience testing, and platform adaptation along the way.
+**Nothing publishes without your say-so. Ever.**
 
-You think. Your agent writes. You decide what goes public.
+```bash
+npm install pressclaw
+```
 
 ---
 
-## How It Works
+## ✨ Features
 
-PressClaw is built on a few beliefs:
+### 🔄 Full Writing Pipeline
+Idea → Draft → Transform → Refine → Test → Publish. Use every step or skip to what you need. Your agent runs the pipeline; you make the calls.
 
-1. **Private first.** Every note starts private. Nothing goes public until you explicitly say so. Your agent can draft, transform, and refine all day — the world sees nothing until you run `publish`.
+### 🧬 Style DNA
+PressClaw learns how *you* write. Sentence rhythm, vocabulary level, perspective, readability — it builds a living style profile from your published work so your agent writes in your voice, not generic AI-speak.
 
-2. **Agent-native.** This isn't a text editor with AI sprinkled on top. Your AI agent does the heavy lifting — drafting, transforming structure, adapting tone, testing against audience personas. The plugin provides the pipeline and guardrails.
+### 🎭 Personas & Tone Control
+Write as yourself, or switch between voices. Built-in tones (authentic, professional, casual, humorous) plus custom personas you define. Create a "technical deep-dive" voice and a "casual newsletter" voice — use either on any post.
 
-3. **Style learning.** As you publish more, PressClaw builds a Style DNA profile from your writing. Sentence length patterns, perspective preferences, vocabulary level, readability scores. Your agent uses this to maintain your voice across everything it writes.
+### 📱 Platform Adaptation
+One post, every platform. Reshape content natively for **LinkedIn** (long-form hooks), **Twitter/X** (punchy single tweets), or **Threads** (numbered breakdowns). Each adapter knows the platform's conventions, limits, and what performs.
 
-4. **Explicit publish only.** The publish command requires confirmation and an optional reason. There's a clear boundary between "drafting space" and "public output." Your agent can't accidentally publish something.
+### 🐦 Twitter Posting
+Publish directly to Twitter/X from your pipeline. Draft → test → adapt → post, all without leaving your terminal.
 
-The flow: **idea → draft → transform → refine → test → publish**. Skip steps as needed. The pipeline is there when you want it.
+### 📡 Agent Feed
+Your published content serves as a clean static site with RSS. Minimal HTML, zero JavaScript, proper typography. Readers get content; you keep control.
 
----
+### 📊 Performance Insights
+Audience-test posts against configurable personas (technical builder, founder, learner, brand strategist) before publishing. Get engagement predictions, sentiment scores, and actionable feedback — so you ship with confidence.
 
-## What You Get
-
-- **Markdown notes** with YAML frontmatter as the source of truth
-- **Static HTML site** with clean typography and an RSS feed
-- **Dashboard** (CLI and web) showing your entire pipeline at a glance
-- **Style DNA** that learns your writing voice over time
-- **7 structure templates** (structured, list, chunky, minimal, storytelling, thread, TL;DR)
-- **Tone control** (authentic, professional, casual, humorous — or custom personas)
-- **Variation generation** — produce multiple versions and pick the best one
-- **Audience testing** against configurable personas (technical builder, founder, learner, brand strategist)
-- **Platform adaptation** — reshape posts for LinkedIn, Twitter/X, or threads
-- **Topic backlog** with workspace scanning to surface publishable ideas
-- **Daily prompt cron** that asks your agent to review conversations and draft content
-- **HTTP serving** through OpenClaw's built-in server
+### 🎰 Variations & A/B Testing
+Generate multiple versions across tone × structure combinations, test each against your audience personas, pick the winner. Data-driven content selection built into the workflow.
+
+### 📋 Topic Backlog
+Never lose an idea. Scan your workspace for publishable insights, maintain a backlog, and draft when you're ready. Includes a daily prompt cron that nudges your agent to review yesterday's conversations.
 
 ---
 
-## Installation
+## 🚀 Quick Start
 
-1. Copy the plugin into your OpenClaw extensions directory:
+### 1. Install
 
 ```bash
-cp -r pressclaw/ ~/.openclaw/extensions/public-thinking/
+openclaw plugins install pressclaw
 ```
 
-Or clone it directly:
+Or from npm:
 
 ```bash
-git clone https://github.com/niklasbabel/pressclaw.git ~/.openclaw/extensions/public-thinking
+npm install pressclaw
 ```
 
-2. Enable it in your `openclaw.json`:
+### 2. Enable in `openclaw.json`
 
 ```json
 {
   "plugins": {
     "entries": {
-      "public-thinking": {
+      "pressclaw": {
         "enabled": true,
         "config": {
           "siteTitle": "My Thinking",
@@ -73,322 +80,77 @@ git clone https://github.com/niklasbabel/pressclaw.git ~/.openclaw/extensions/pu
 }
 ```
 
-> **Note:** The plugin ID is `public-thinking` for backward compatibility. The name in the UI shows as "PressClaw."
-
-3. Initialize:
+### 3. Initialize & Go
 
 ```bash
-openclaw notes init
+openclaw notes init          # Set up directories
+openclaw notes new "My first post"   # Create a draft
+openclaw notes transform my-first-post --tone authentic --structure storytelling
+openclaw notes test my-first-post    # Audience test it
+openclaw notes publish my-first-post # Ship it 🚀
 ```
 
-4. (Optional) Set up the daily content prompt:
+### 4. See everything at a glance
 
 ```bash
-openclaw notes setup
+openclaw notes               # Full pipeline dashboard
 ```
 
 ---
 
-## Configuration
-
-All settings live under `plugins.entries.public-thinking.config` in your `openclaw.json`:
-
-| Key | Type | Default | Description |
-|-----|------|---------|-------------|
-| `baseUrl` | string | `""` | Public URL for absolute links in RSS |
-| `publicPath` | string | `"/public"` | URL path prefix for the HTTP server |
-| `notesDir` | string | `""` | Notes directory (default: `{workspace}/notes`) |
-| `outputDir` | string | `""` | Output directory (default: `{workspace}/public`) |
-| `siteTitle` | string | `"Your Thinking"` | Site and RSS feed title |
-| `authorName` | string | `""` | Author name in post footers |
-| `dailyPrompt.enabled` | boolean | `true` | Enable the daily content cron job |
-| `dailyPrompt.schedule` | string | `"0 10 * * *"` | Cron expression (default: 10 AM daily) |
-| `dailyPrompt.timezone` | string | `"UTC"` | Timezone for the schedule |
-| `dailyPrompt.prompt` | string | *(see below)* | The prompt sent to the agent |
-
-### Default Daily Prompt
-
-> Review yesterday's conversations and daily notes. Identify any interesting ideas, insights, or learnings worth sharing publicly. If you find something compelling, draft a short note (3-8 paragraphs) that distills the idea for a general audience. Use `openclaw notes new "<title>"` to create it, then write the content. Don't publish yet — just draft. If nothing stands out, that's fine — skip today.
-
----
-
-## Command Reference
-
-### Dashboard
-
-```bash
-openclaw notes
-```
-
-Shows the full pipeline at a glance: published, refined, drafted, ideas, untracked files, style profile status, and confidence scores.
-
-### Creating & Managing Notes
-
-```bash
-openclaw notes new "Title of your note"
-```
-
-Creates a private markdown file with frontmatter pre-filled. Ready to write.
-
-```bash
-openclaw notes list
-```
-
-Lists all notes with status indicators (🔒 private, ✨ refined, 📢 public) plus any untracked topic ideas.
-
-```bash
-openclaw notes preview <slug>
-```
-
-Shows a note's full content, metadata, word count, tone, structure, and confidence score.
-
-```bash
-openclaw notes voice "Title"
-```
-
-Creates a note marked as voice input. Use for transcribed audio — creates both the note file and a topic entry.
-
-### The Pipeline
-
-```bash
-openclaw notes transform <slug> [--tone <tone>] [--structure <structure>]
-```
-
-Outputs detailed transform instructions for your agent. Injects the style profile, structure template, and tone guidelines. Your agent rewrites the note following these constraints.
-
-**Tones:** `authentic` | `professional` | `casual` | `humorous`
-**Structures:** `structured` | `list` | `chunky` | `minimal` | `storytelling` | `thread` | `tldr`
-
-```bash
-openclaw notes refine <slug>
-```
-
-Marks a note as refined (ready for review). Extracts style markers, updates the aggregate style profile, and syncs topic status.
-
-```bash
-openclaw notes test <slug>
-```
-
-Runs audience testing against multiple personas. Each persona evaluates the content from their perspective and provides a score, sentiment, and specific feedback. Results are saved for comparison.
-
-```bash
-openclaw notes publish <slug> [--yes] [--reason <text>]
-```
-
-Publishes a note: sets status to public, rebuilds the HTML site and RSS feed, extracts style markers, updates the style profile. Requires confirmation unless `--yes` is passed.
-
-```bash
-openclaw notes unpublish <slug>
-```
-
-Reverts a note to private and removes it from the public site.
-
-```bash
-openclaw notes build
-```
-
-Regenerates all HTML pages and the RSS feed from published notes. Run after manual edits.
-
-### Branding OS
-
-```bash
-openclaw notes style [--from <slugs>]
-```
-
-Analyzes your writing across refined/published notes and generates a style profile. Extracts voice description, markers (sentence length, perspective, emoji usage, vocabulary), anti-patterns to avoid, and example openers/closers. Use `--from` with comma-separated slugs to analyze specific notes.
-
-```bash
-openclaw notes analyze <slug>
-```
-
-Extracts per-note style markers (sentence count, paragraph count, word count, avg sentence length, perspective, emoji usage, Flesch-Kincaid readability) and saves them to the note's frontmatter.
-
-```bash
-openclaw notes vary <slug> [--tones <tones>] [--structures <structures>]
-```
-
-Generates multiple variations of a note across tone × structure combinations. Default: 4 tones × 1 structure = 4 variations. All saved to `.variations/<slug>/` with a manifest for tracking.
-
-```bash
-openclaw notes variations <slug>
-```
-
-Shows all generated variations for a note with their tone, structure, word count, test status, confidence, and selection state.
-
-```bash
-openclaw notes pick <slug> <variation>
-```
-
-Selects a variation and copies its content into the main note file. Updates frontmatter with the variation's tone and structure.
-
-### Platform Adaptation
-
-```bash
-openclaw notes adapt <slug> --platform <platform>
-```
-
-Reshapes a blog post for a specific platform with detailed format rules, character limits, structure guidance, and examples of good native content.
-
-**Platforms:**
-- `linkedin` — Long-form post (3000 chars), hook-first, no markdown, hashtags at end
-- `twitter` — Single tweet (280 chars), punchy take, no hashtags
-- `thread` — Numbered thread (5-10 tweets), hook in tweet 1, recap + CTA at end
-
-### Topic Backlog
-
-```bash
-openclaw notes topics
-```
-
-Shows the full topic backlog organized by status: ideas, drafted, refined, published.
-
-```bash
-openclaw notes topics add "Title" [--source <text>] [--tags <tags>]
-```
-
-Adds a new topic idea. Source tracks where the idea came from. Tags are comma-separated.
-
-```bash
-openclaw notes topics draft <id-or-title>
-```
-
-Creates a note file from a topic idea, links them, and updates the topic status to "drafted."
-
-```bash
-openclaw notes topics remove <id-or-title>
-```
-
-Removes a topic from the backlog.
-
-```bash
-openclaw notes topics scan [--suggest]
-```
-
-Scans your entire workspace for markdown files not yet linked to any topic. With `--suggest`, outputs a prompt for your agent to evaluate which files contain publishable ideas.
-
-### Setup
-
-```bash
-openclaw notes init
-```
-
-Creates notes and output directories, copies a starter template. Run once.
-
-```bash
-openclaw notes setup
-```
-
-Creates the daily prompt cron job (`public-thinking-daily`) using your configured schedule and prompt.
-
----
-
-## Branding OS
-
-PressClaw includes a style system that learns and maintains your writing voice.
-
-### Style DNA
-
-Every time you publish or refine a note, PressClaw extracts style markers:
-- Average sentence length and paragraph density
-- Perspective patterns (first-person, second-person, mixed)
-- Emoji usage frequency
-- Flesch-Kincaid readability score
-
-These aggregate into a `.style-profile.json` that your agent references when writing new content. The profile evolves over time — recent notes are weighted more heavily, and evolution snapshots track how your style changes.
-
-### Structure Templates
-
-Seven built-in structures control how content is organized:
+## 🏗️ Structure Templates
 
 | Template | Best For |
 |----------|----------|
 | `structured` | Technical explanations — headers + sections |
-| `list` | Actionable advice — numbered points with sub-details |
-| `chunky` | Mobile/scrollable — short paragraphs, rhythm-based |
-| `minimal` | Expert audiences — dense prose, no decoration |
-| `storytelling` | Experience-based — narrative arc with hook → tension → insight |
-| `thread` | Twitter/X — hook-first numbered segments |
-| `tldr` | Busy readers — conclusion first, then expand |
-
-### Voice Personas
-
-Create named style profiles in `.style-profiles/` for different writing voices. Each persona carries its own voice description, vocabulary patterns, and anti-patterns. Reference them by name in the tone field.
-
-### Variations & Testing
-
-The `vary` → `test` → `pick` workflow lets you:
-1. Generate multiple versions across tone/structure combinations
-2. Test each against audience personas for engagement prediction
-3. Pick the winner and promote it to the main note
-
-### Platform Adaptation
-
-Transform blog posts into platform-native content. Each platform adapter carries detailed conventions, character limits, structure rules, and real examples — so the output feels native, not copy-pasted.
-
-### Style Evolution
-
-The dashboard tracks your style over time with evolution snapshots: sentence length trends, word count changes, readability shifts. See how your writing develops as you publish more.
+| `list` | Actionable advice — numbered points |
+| `chunky` | Mobile-friendly — short paragraphs, rhythm-based |
+| `minimal` | Expert audiences — dense prose |
+| `storytelling` | Experience-based — narrative arc |
+| `thread` | Twitter/X — hook-first segments |
+| `tldr` | Busy readers — conclusion first |
 
 ---
 
-## Note Format
-
-Notes are markdown files with YAML frontmatter:
+## 💰 Free vs Premium
+
+| | **Free** | **Premium** |
+|---|---|---|
+| Writing pipeline | ✅ Full pipeline | ✅ Full pipeline |
+| Style DNA | ✅ Style learning | ✅ Style learning |
+| Structure templates | ✅ All 7 templates | ✅ All 7 templates |
+| Tone control | ✅ 4 built-in tones | ✅ + Custom personas |
+| Audience testing | ✅ 4 personas | ✅ + Custom personas |
+| Platform adaptation | ✅ LinkedIn, Twitter, Threads | ✅ LinkedIn, Twitter, Threads |
+| Topic backlog | ✅ Full backlog | ✅ Full backlog |
+| Daily prompt cron | ✅ Included | ✅ Included |
+| Static site + RSS | ✅ Included | ✅ Included |
+| Direct Twitter posting | — | ✅ Post from pipeline |
+| Advanced analytics | — | ✅ Style evolution tracking |
+| Priority support | — | ✅ Direct access |
+
+**PressClaw is fully functional for free.** Premium unlocks power-user features for serious publishers.
 
-```markdown
----
-title: "My Note Title"
-slug: "my-note-title"
-status: private
-published_at: null
-tone: null
-structure: null
-confidence: null
-tags: [ideas, tech]
 ---
 
-# My Note Title
+## 📖 Full Documentation
 
-Your content here...
-```
+For the complete command reference, configuration options, and architecture details, visit:
 
-### Frontmatter Fields
-
-| Field | Description |
-|-------|-------------|
-| `title` | Display title |
-| `slug` | URL-safe identifier (auto-generated) |
-| `status` | `private`, `refined`, or `public` |
-| `published_at` | Timestamp set on publish |
-| `publish_reason` | Why you published this (optional) |
-| `topic_id` | Link to topic backlog entry |
-| `input_type` | How the note was created (`voice`, etc.) |
-| `tone` | Applied tone (authentic, professional, casual, humorous, or persona name) |
-| `structure` | Applied structure template |
-| `confidence` | Audience test score (0-10) |
-| `tags` | Array of tags |
-| `style_markers` | Auto-extracted style analysis (JSON) |
+🌐 **[pressclaw.com](https://pressclaw.com)**
 
 ---
 
-## Architecture
-
-PressClaw runs as an OpenClaw plugin. It registers:
-
-- **CLI commands** under `openclaw notes` — the primary interface
-- **HTTP handler** serving the public blog at your configured path, plus a private `/dashboard` view
-- **Cron job** (optional) for daily content prompting
+## 🔗 Links
 
-All data lives in your workspace as markdown files and JSON. No database, no external services. The style system uses weighted averages with recency decay — recent notes influence the profile more than older ones.
-
-The HTML site is regenerated on every publish/unpublish/build. Clean, minimal CSS. No JavaScript. RSS feed included.
+- 🌐 Website: [pressclaw.com](https://pressclaw.com)
+- 🐦 Twitter: [@pressclawai](https://twitter.com/pressclawai)
+- 📦 npm: [npmjs.com/package/pressclaw](https://www.npmjs.com/package/pressclaw)
+- 💻 GitHub: [github.com/niklasbabel/pressclaw](https://github.com/niklasbabel/pressclaw)
+- 🤖 Built for [OpenClaw](https://openclaw.ai)
 
 ---
 
 ## License
 
 MIT — see [LICENSE](LICENSE).
-
----
-
-Built for [OpenClaw](https://openclaw.ai). Docs at [docs.openclaw.ai](https://docs.openclaw.ai).