README.md in wordless-0.0.2 vs README.md in wordless-0.1.0
- old
+ new
@@ -1,30 +1,46 @@
# Wordless
A command line tool to help manage your [Wordless](http://welaika.github.com/wordless/)-based WordPress sites.
-WARNING: This gem is in early development and barely does anything useful yet.
-
## Installation
- $ gem install wordless
+ gem install wordless
## Usage
-`wordless help` shows some help.
-`wordless wp mysite` creates a `mysite` directory and installs the latest stable release of WordPress.
-`wordless wp --locale=fr_FR --bare` installs the French version of WordPress, and removes default plugins and themes.
-`wordless install` installs the Wordless plugin in the current WordPress installation as a git submodule.
+Create a new Wordless-enabled WordPress site in directory `mysite`. This downloads the latest stable release of WordPress (you can also specify a locale):
+ wordless new mysite
+ wordless new mysite --locale=fr_FR
+
+If you already have WordPress installed, you can install the Wordless plugin (this currently installs from the master branch on GitHub):
+
+ wordless install
+
+Once Wordless is installed, you can create a new Wordless theme:
+
+ wordless theme mytheme
+
+You can also simply install the latest stable release of WordPress, with an optional locale:
+
+ wordless wp mysite
+ wordless wp mysite --locale=fr_FR
+
+Get some help:
+
+ wordless help
+
## Caveats
- If you attempt to download a WordPress localization that's outdated, the latest English version will be downloaded instead.
-- Currently, the Wordless plugin is installed as a git submodule, so your WordPress directory must be a git repo.
-- The Cucumber features run very slowly because they actually download WordPress and the Wordless plugin. I haven’t figured out how to properly stub the downloads.
+- Only tested on Mac OS X
+- Specs that test installation of the plugin actually download the plugin from GitHub. This makes the specs a bit slow to run.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+3. Add some specs
+4. Commit your changes (`git commit -am 'Added some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request