diff --git a/README.md b/README.md new file mode 100644 index 0000000..5653090 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# w 🔥 + +### WordBoxed—A truly modern development environment for WordPress + +WordBoxed is a truly modern WordPress site development (and deployment) environment. + +Bring the power of Node.JS to your WordPress environment! + +### Running the server + +1. Download php zip from https://php.net and place the extracted files under `/php`. +2. Download WordPress from https://wordpress.org and place the extracted files under `/wp`. +3. [Optional] If you're on Linux, edit the config file to point to your `php-cgi` bin file. +4. Run `npm install` to install dependencies (Express). +5. Run `node .` to start the server. \ No newline at end of file diff --git a/package.json b/package.json index 49e993c..f4fa3d8 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { - "name": "wordboxed", + "name": "w", "version": "0.1.0", - "description": "A fully sandboxed WordPress installation", + "description": "WordBoxed—A truly modern WordPress site development (and deployment) environment.", "main": "server.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" @@ -11,6 +11,7 @@ "url": "git+https://github.com/codefeathers/wordboxed.git" }, "keywords": [ + "w", "wordpress", "node", "express",