Merge branch 'master' of github.com:miningold/assetman

README.md

@@ -7,15 +7,15 @@ to convert the files and place them in a DVCS repo such as Git.
 ## Why
 
 Distributed version control systems often store entire copies of the repository
-in you working directory. Large binary files, such as `.psd`s, cannot be diff'ed
-by Git so any time a change is made to these files, another copy of the PSD is
+in you working directory. Large binary files, such as `.psd` files, cannot be diff'ed
+by Git so any time a change is made to these files, another copy of the `.psd` is
 added to the repository. Each developer then will end up with multiple copies
 of these large asset files.
 
 Boar on the other hand is designed to store large binary files in a centralized
 location. The centralized location lets each developer only download the most
 recent revision of each file. `assetman` will allow you to store the raw assets
-in a boar repo and automatically convert them to smaller assets, such as `.png`s,
+in a boar repo and automatically convert them to smaller assets, such as `.png` files,
 for storage in your DVCS repo.
 
 The other use of the boar repo is for "Master Assets". If the compressed assets
@@ -32,6 +32,8 @@ for any project using large binary, convertible assets and a DVCS repo.
 <!-- Install the module with: `npm install -g assetman` (Not actually in the npm repo yet). -->
 In this example we will be using [Git](http://git-scm.com/) as our DVCS.
 
+Install assetman with: `npm install -g assetman`
+
 Setup your Git and Boar repositorys:
 
 ```bash
@@ -74,9 +76,10 @@ Running `assetman all` will convert the matching `.psd` and `.wav` files in the
 ## Commands
 
 * `all` This command will convert all assets in the `boar_repo` folder.
-* `recent` Scan the boar log and convert and modified or new files in the last commit.
+* `recent` Scan the boar log and convert modified or new files in the last commit.
 * `convert` Takes a pattern argument and converts all the files that match using
-the appropriate converter from `assets.json`.
+the appropriate converter from `assets.json`. Take care to use quotation marks when
+specifying a pattern. Example: `assetman convert "images/*.*"`.
 
 Both `all` and `recent` take optional filters that should match the `tag` fields
 in the `assets.json` file such as `assetman all images` or `assetman recent audio images`.
@@ -91,7 +94,7 @@ in the `assets.json` file such as `assetman all images` or `assetman recent audi
     {
       "pattern": "glob pattern to match relative to boar_repo",
       "tag": "optional tag which identifies which filter this converter belongs to",
-      "commands": "a string or array of strings, each one a command line to to execute"
+      "commands": "a string or array of strings, each one a command line to execute"
     }
   ]
 }