README.md in marv-0.3.0 vs README.md in marv-0.3.1
- old
+ new
@@ -1,56 +1,69 @@
## What is Marv?
-Marv is a free command-line toolkit for bootstrapping and developing WordPress themes in a tidy environment using front-end languages like Sass, LESS, and CoffeeScript.
+Marv is a free command-line toolkit for bootstrapping and developing WordPress themes and plugins in a tidy environment using front-end languages like Sass, LESS, and CoffeeScript.
[![Gem Version](https://badge.fury.io/rb/marv.png)](http://badge.fury.io/rb/marv)
## How does it work?
-Marv creates a neatly organized source folder with clean and simple scaffolding (base template files, SCSS files). The source folder is automatically compiled to your local WordPress install(s) as you save changes and work on your theme. When you are ready to distribute your theme Marv will build it to a folder of your choice or bundle the theme up into an easy to install zip package.
+Marv creates a neatly organized source folder with clean and simple scaffolding (base template files, SCSS files). The source folder is automatically compiled to your Marv development server(s) or local WordPress install(s) as you save changes and work on your project. When you are ready to distribute your project Marv will build it to a folder of your choice or bundle the project up into an easy to install zip package.
## Why use Marv?
-Marv accelerates development by giving you access to higher-level languages like Sass, LESS, and CoffeeScript. These languages are much quicker and cleaner to code, but still compile to normal CSS and JavaScript. Marv also makes it easy to quickly bootstrap into and a more modular development environment, while still compiling "by the book" WordPress theme code.
+Marv accelerates development by giving you access to higher-level languages like Sass, LESS, and CoffeeScript. These languages are much quicker and cleaner to code, but still compile to normal CSS and JavaScript. Marv also makes it easy to quickly bootstrap into and a more modular development environment, while still compiling "by the book" WordPress code.
## Basic setup
Install Marv (requires [Ruby](http://www.ruby-lang.org/) and [RubyGems](http://rubygems.org/)):
$ gem install marv
-Create your new theme project:
+Create your new project:
- $ marv create themename
+ $ marv create project-name
-Link to your WordPress theme folder:
+Create a Marv development server:
- $ marv link /wordpress/wp-content/themes/my-theme
+ $ marv server server-name
+Link to your Marv server:
+
+ $ cd project-name
+ $ marv link server-name --folder themes
+ $ marv link server-name --folder plugins
+
+Also you can link to a WordPress installation:
+
+ $ cd project-name
+ $ marv link /var/www/wordpress --folder themes
+ $ marv link /var/www/wordpress --folder plugins
+
Watch for changes and start developing!
- $ cd themename
+ $ cd project-name
$ marv watch
Press Ctrl + Z to exit watch mode
-Build your theme into the build_here directory:
+Build your project into the build_here directory:
$ marv build build_here
-Package your theme as themename.zip:
+Package your project as package-name.zip:
- $ marv package themename
+ $ marv package package-name
## Help
Get a little help with the Marv commands:
$ marv help
+ $ marv help command
See the [user's manual](https://github.com/hardpixel/marv/wiki) for more information.