@rnaga/wp-node 1.1.2 → 1.1.3

package/README.md

@@ -69,43 +69,128 @@ docker run -d --name wp --network wpnet -p 8080:80 \
   wordpress
 ```
 
-## Configuration
+Visit http://localhost:8080 in your browser to complete the WordPress setup.
 
-Create your config:
+### Initialize WP-Node Project
+
+WP-Node requires an initialized configuration before use. You can scaffold a new project using the CLI.
+
+```sh
+mkdir /tmp/test-wp-node
+cd /tmp/test-wp-node
+npx @rnaga/wp-node-cli -- init
+```
+
+Then enter prompts as follows:
 
 ```sh
-npx @rnaga/wp-node-cli -- config
+✔ Enter your database hostname: · localhost
+✔ Enter your database port: · 33306
+✔ Enter your database username: · wp
+✔ Enter your database password: · **
+✔ Enter your database name: · wordpress
+✔ Is it a multi-site? · No
+✔ Enter your static assets path: · public
 ```
 
-It will prompt for database settings and generate:
+### Project Structure
+
+After initialization, your project will look like this:
 
 ```
-_wp/
-  └── config/wp.json
-.env
+./
+├── _wp
+│   ├── config
+│   │   ├── index.d.ts
+│   │   └── wp.json
+│   └── settings.ts
+├── .env
+├── index.ts
+├── package-lock.json
+├── package.json
+└── tsconfig.json
+```
+
+**Key files**
+
+- `_wp/config/wp.json`: Holds configuration for WP-Node such as public path and multisite info. This file is imported by settings.ts.
+- `_wp/settings.ts`: Initializes the WP-Node Context, including config, database access and hooks.
+- `index.ts`: The main entry point for your WP-Node app. A basic sample is provided.
+- `.env`: Stores sensitive environment variables, including your database credentials and other configuration values required at runtime.
+
+### Run the App
+
+Once the config is initialized, run the app using:
+
+```sh
+mvn use 22
+npx ts-node ./index.ts
 ```
 
-You can configure additional settings such as:
+If everything is working correctly, you’ll see SQL output like:
+
+```sh
+select * from `wp_posts` as `posts_5` where `posts_5`.`ID` = 1
+[
+  {
+    ID: 1,
+    post_author: 1,
+    post_title: 'Hello world!',
+    ...
+  }
+]
+```
 
-- `staticAssetsPath`: Path for media references
-- `multisite.enabled`: Enable or disable multisite support
-- Custom post types, taxonomies, statuses
+## CLI
 
-## CLI Usage
+WP-Node CLI provides a convenient way to interact with WordPress data without writing any code.
 
-Install CLI tools:
+To query a post (e.g. ID = 1), run:
 
 ```sh
-npm i -S @rnaga/wp-node-cli -- -h
+npx @rnaga/wp-node-cli -- post get 1 -Z table -F ID,post_title,post_type
+
+┌────────────┬────────────────┐
+│ (index)    │ Values         │
+├────────────┼────────────────┤
+│ ID         │ 1              │
+│ post_title │ 'Hello world!' │
+│ post_type  │ 'post'         │
+└────────────┴────────────────┘
 ```
 
-Basic command to list posts:
+### Listing Available Commands
+
+To view all available CLI commands, run:
+
+```
+npx @rnaga/wp-node-cli -- -h
+```
+
+output:
 
 ```sh
-npx @rnaga/wp-node-cli -- post list
+Usage: <command> <subcommand> [options]
+
+Commands:
+   blog             Blog commands
+   comment          Comment commands
+   config           Generate WP config files
+   init             Initialize WP with Node. (Generate wp.json and install dependencies)
+   install          Initialize a new blog and create a user
+   meta             Meta commands (post, comment, blog, term, user, site)
+   option           Options commands
+   post             Post commands
+   repl             Start a REPL
+   role             Role commands
+   site             Site commands
+   term             Term commands
+   user             User commands
 ```
 
-Develop your own commands using decorators:
+### Develop your CLI using decorators:
+
+**Example**:
 
 ```ts
 @command("page", { description: "Page commands" })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rnaga/wp-node",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "",
   "scripts": {
     "build": "rm -rf ./dist && tsc --project tsconfig.build.json && npm run copyfiles && cp package.json ./dist/",