@readpress/wp-blog 1.0.3 → 1.0.4

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.
Files changed (2) hide show
  1. package/README.md +12 -4
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,10 +2,10 @@
2
2
 
3
3
  A minimal, read-only headless WordPress blog adapter for modern web apps. Useful when you already have a web app and want to ship a fast, reliable blog from a WordPress installation.
4
4
 
5
- - Fetch and search posts, plus authors, categories, and tags
6
- - Supports drafts/private posts with auth
7
- - Framework-agnostic core with Next.js App Router docs and examples
8
- - Read-only by design
5
+ - Fetch posts, authors, categories, and tags; includes post search
6
+ - Supports draft/private reads for preview flows with auth
7
+ - Framework-agnostic core with Next.js App Router examples
8
+ - Read-only API (no write/update operations)
9
9
 
10
10
  ## Requirements
11
11
 
@@ -40,6 +40,14 @@ WP_REST_ENDPOINT=/wp-json/wp/v2/posts
40
40
  ## Quick start
41
41
  See docs/quickstart.mdx
42
42
 
43
+ ## AI-ready docs
44
+
45
+ This repo has clear docs with examples to support rapid setup with AI coding agents (e.g., Codex, Cursor).
46
+
47
+ Recommended:
48
+ - Connect your agent to GitHub MCP so it can read docs directly from this repository.
49
+ - Or point your agent to the `docs/` folder in this repo on GitHub.
50
+
43
51
  ## Examples
44
52
  - `examples/nextjs-blog`
45
53
  - `examples/gutenberg-blocks-tailwind`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@readpress/wp-blog",
3
- "version": "1.0.3",
3
+ "version": "1.0.4",
4
4
  "description": "A minimal, read-only headless WordPress blog adapter for modern web apps",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",