content-grade 1.0.4 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -3,39 +3,41 @@
3
3
  > AI-powered content quality scoring for developers and content teams. Score any blog post, landing page, ad copy, or email — in under 30 seconds. No API keys. No accounts. Runs on your local Claude CLI.
4
4
 
5
5
  [![npm](https://img.shields.io/npm/v/content-grade.svg)](https://www.npmjs.com/package/content-grade)
6
+ [![npm downloads/month](https://img.shields.io/npm/dm/content-grade.svg)](https://www.npmjs.com/package/content-grade)
7
+ [![npm downloads/week](https://img.shields.io/npm/dw/content-grade.svg)](https://www.npmjs.com/package/content-grade)
6
8
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7
9
  [![Node.js 18+](https://img.shields.io/badge/node-%3E%3D18-brightgreen)](https://nodejs.org)
8
10
  [![Requires Claude CLI](https://img.shields.io/badge/requires-Claude%20CLI-orange)](https://claude.ai/code)
11
+ [![GitHub Discussions](https://img.shields.io/badge/GitHub-Discussions-blue?logo=github)](https://github.com/content-grade/Content-Grade/discussions)
12
+ [![Early Adopter seats open](https://img.shields.io/badge/Early%20Adopter-50%20seats%20open-success)](EARLY_ADOPTERS.md)
9
13
 
10
14
  ---
11
15
 
12
16
  ## 60-second quickstart
13
17
 
14
18
  ```bash
15
- # 1. Verify Claude CLI is installed and logged in
16
- claude -p "say hi"
17
-
18
- # 2. Run instant demo — no file needed, see results in ~30 seconds
19
+ # Step 1: See it in action instant demo, no file needed
19
20
  npx content-grade
20
21
 
21
- # 3. Analyze your own content (grade is an alias for analyze)
22
+ # Step 2: Score your own content
23
+ npx content-grade grade README.md
22
24
  npx content-grade grade ./my-post.md
23
- npx content-grade analyze ./my-post.md
24
-
25
- # 4. CI pipeline — get raw JSON or score-only output
26
- npx content-grade analyze ./post.md --json
27
- npx content-grade analyze ./post.md --quiet # prints score number only
28
25
 
29
- # 5. Grade a headline
26
+ # Step 3: Grade a headline
30
27
  npx content-grade headline "Why Most Startups Fail at Month 18"
31
-
32
- # 6. Unlock Pro (batch mode, 100/day limit)
33
- npx content-grade activate
34
28
  ```
35
29
 
36
- **One requirement:** [Claude CLI](https://claude.ai/code) must be installed and logged in. No API keys, no accounts, no data leaves your machine.
30
+ **One requirement:** [Claude CLI](https://claude.ai/code) must be installed and logged in (`claude login`). No API keys, no accounts, your content never leaves your machine.
37
31
 
38
- **Free tier:** 50 analyses/day, no signup needed. `npx content-grade grade README.md` works immediately.
32
+ **Free tier:** 50 analyses/day. No signup. `npx content-grade grade README.md` works immediately.
33
+
34
+ ```bash
35
+ # More commands
36
+ npx content-grade https://yourblog.com/post # analyze any URL
37
+ npx content-grade analyze ./post.md --json # raw JSON for CI pipelines
38
+ npx content-grade analyze ./post.md --quiet # score number only (for scripts)
39
+ npx content-grade activate # unlock Pro: batch mode, 100/day
40
+ ```
39
41
 
40
42
  ---
41
43
 
@@ -82,7 +84,7 @@ npx content-grade activate
82
84
  1. Why 90% of SaaS Startups Fail at Month 18 (and How to Be the 10%)
83
85
  2. The Month 18 Startup Trap: What Kills Growth-Stage Companies
84
86
 
85
- Unlock team features at contentgrade.dev
87
+ Unlock team features at content-grade.github.io/Content-Grade
86
88
  ```
87
89
 
88
90
  ---
@@ -139,7 +141,7 @@ Launch with `content-grade start` — opens at [http://localhost:4000](http://lo
139
141
  | **EmailForge** | `/email-forge` | Subject line + body copy for click-through optimization |
140
142
  | **AudienceDecoder** | `/audience` | Twitter handle → audience archetypes and content patterns |
141
143
 
142
- Free tier: **50 analyses/day per tool**. Pro ($9/mo): **100 analyses/day** + all tools.
144
+ Free tier: **50 analyses/day per tool**. Pro ($19/mo): **100 analyses/day** + all tools.
143
145
 
144
146
  ---
145
147
 
@@ -317,7 +319,7 @@ Stripe variables are entirely optional — all tools work without them; upgrade
317
319
  ## Self-hosting / Development
318
320
 
319
321
  ```bash
320
- git clone https://github.com/StanislavBG/Content-Grade
322
+ git clone https://github.com/content-grade/Content-Grade
321
323
  cd Content-Grade
322
324
  npm install
323
325
  npm run dev # hot reload: server at :4000, client at :3000
@@ -348,6 +350,11 @@ tests/
348
350
 
349
351
  **REST API:** The web dashboard exposes a full REST API at `http://localhost:4000`. See [`docs/api.md`](./docs/api.md) for the complete reference — every endpoint, request shape, response schema, and cURL examples.
350
352
 
353
+ **Documentation:**
354
+ - [`docs/getting-started.md`](./docs/getting-started.md) — step-by-step first-run guide
355
+ - [`docs/examples.md`](./docs/examples.md) — real-world examples for all 6 tools, CI/CD workflows, Node.js integration
356
+ - [`docs/api.md`](./docs/api.md) — full REST API reference
357
+
351
358
  **Run tests:**
352
359
 
353
360
  ```bash
@@ -709,7 +716,7 @@ echo "$DATE,$HEADLINE,$SCORE" >> headline-scores.csv
709
716
 
710
717
  | | Free | Pro |
711
718
  |-|------|-----|
712
- | Price | Free forever | $9/month |
719
+ | Price | Free forever | $19/month |
713
720
  | Analyses/day (CLI) | Unlimited | Unlimited |
714
721
  | Analyses/day (web dashboard, per tool) | 3 | 100 |
715
722
  | HeadlineGrader (single grade) | ✓ | ✓ |
@@ -736,6 +743,66 @@ The web dashboard works the same way — every tool call goes through `claude -p
736
743
 
737
744
  ---
738
745
 
746
+ ## Community
747
+
748
+ ContentGrade is built in public. The community is the roadmap.
749
+
750
+ ### GitHub Discussions
751
+
752
+ **[Join the conversation →](https://github.com/content-grade/Content-Grade/discussions)**
753
+
754
+ | Category | What it's for |
755
+ |----------|--------------|
756
+ | [Q&A](https://github.com/content-grade/Content-Grade/discussions/new?category=q-a) | "Why is my score lower than expected?" — questions get answered here |
757
+ | [Show & Tell](https://github.com/content-grade/Content-Grade/discussions/new?category=show-and-tell) | Share your workflow, integration, or results — early adopters post here |
758
+ | [Ideas](https://github.com/content-grade/Content-Grade/discussions/new?category=ideas) | Feature requests and suggestions before they become issues |
759
+
760
+ ### Early Adopter Program — 50 seats
761
+
762
+ **[EARLY_ADOPTERS.md](EARLY_ADOPTERS.md)** — The first 50 users who install and share feedback get:
763
+
764
+ - **Pro tier free for 12 months** ($19/mo value)
765
+ - Direct feedback channel with the maintainer
766
+ - Name in CONTRIBUTORS.md (permanent)
767
+ - Roadmap preview + design input before features ship
768
+ - 30-minute onboarding call (optional)
769
+
770
+ One action to claim: run ContentGrade, then post in [Show & Tell](https://github.com/content-grade/Content-Grade/discussions/new?category=show-and-tell) with `[Early Adopter]` in the title.
771
+
772
+ ### Champions Program
773
+
774
+ Power users who go beyond early adoption get early access to `@beta` releases, a private Champions discussion thread, and a SVG badge for their profile. See **[CHAMPIONS.md](CHAMPIONS.md)** for selection criteria and current members.
775
+
776
+ ### Contributing
777
+
778
+ See **[CONTRIBUTING.md](CONTRIBUTING.md)** for local dev setup, PR guidelines, and how to write good bug reports. The short version: clone → `pnpm install` → `pnpm dev` → file a PR. All contributions get a review within 48 hours.
779
+
780
+ ### Roadmap
781
+
782
+ **[ROADMAP.md](ROADMAP.md)** — what's built, what's next, what's planned, and what we're deliberately not doing. Open a [Discussion](https://github.com/content-grade/Content-Grade/discussions/new?category=ideas) to challenge or extend it.
783
+
784
+ ### Feedback Loop
785
+
786
+ **[FEEDBACK_LOOP.md](FEEDBACK_LOOP.md)** — how feedback flows into product decisions. Monthly structured check-ins, 48h triage SLA, and roadmap sync. Use the [monthly feedback template](https://github.com/content-grade/Content-Grade/issues/new?template=monthly_feedback.yml) to share your experience.
787
+
788
+ ### Contributors
789
+
790
+ **[CONTRIBUTORS.md](CONTRIBUTORS.md)** — everyone who has improved ContentGrade. Code, bug reports, and real-world feedback all count. Early Adopters and Champions are listed here permanently.
791
+
792
+ ### Use ContentGrade in your project
793
+
794
+ Add a badge to show your content meets the bar:
795
+
796
+ ```markdown
797
+ [![content-grade](https://img.shields.io/badge/content--grade-passing-brightgreen)](https://www.npmjs.com/package/content-grade)
798
+ ```
799
+
800
+ Score-specific badge: `https://img.shields.io/badge/content--grade-{SCORE}%2F100-brightgreen`
801
+
802
+ See [docs/social-proof/built-with-badge.md](docs/social-proof/built-with-badge.md) for SVG assets and CI integration examples.
803
+
804
+ ---
805
+
739
806
  ## License
740
807
 
741
808
  MIT