README.md in morph-cli-0.0.2 vs README.md in morph-cli-0.1
- old
+ new
@@ -1,27 +1,38 @@
[](http://badge.fury.io/rb/morph-cli)
-# Morph
+# Morph Commandline
-TODO: Write a gem description
+Runs Morph scrapers from the commandline.
-## Installation
+Actually it will run them on the Morph server identically to the real thing. That means not installing a bucket load of libraries
+and bits and bobs that are already installed with the Morph scraper environments.
-Add this line to your application's Gemfile:
+To run a scraper in your local directory
- gem 'morph-cli'
+ morph
-And then execute:
+Yup, that's it.
- $ bundle
+It runs the code that's there right now. It doesn't need to be checked into git or anything.
-Or install it yourself as:
+For help
- $ gem install morph-cli
+ morph help
-## Usage
+## Installation
-TODO: Write usage instructions here
+You'll need Ruby >= 1.9 and then
+
+ gem install morph-cli
+
+## Limitations
+
+It doesn't currently stream the console output from the Morph server so you have to wait until the scraper has finished running before you see the output. I want to add streaming as soon as possible because it will make this a whole lot more responsive and usable.
+
+It uploads your code everytime. So if it's big it might take a little while. Scrapers are not usually so I'm hoping this won't really be an issue
+
+It doesn't yet return you the resulting sqlite database.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)