README.md in caramelize-0.0.3 vs README.md in caramelize-0.1.0
- old
+ new
@@ -6,12 +6,10 @@
## Usage
### Building
-For the moment caramelize is not yet stable and not released to any gemsites.
-
To try it you require bundler to build it.
$ gem bundler install
Clone this repository and start building.
@@ -29,23 +27,34 @@
to install the new gem right to the system.
### Use
- $ caramelize create <directory>
+ $ caramelize create
-Creates a template configuration file. This includes documentation on how to use the preset Wiki-connectors and how to write addition customized connectors.
+Creates a template configuration file "caramel.rb". This includes documentation on how to use the preset Wiki-connectors and how to write addition customized connectors.
-
$ caramelize run
Will execute a wiki migration based on a found configuration file. These are found in predefined paths.
$ caramelize help
+
Returns help information.
$ caramelize version
+
Returns version and release information.
+
+### Options
+
+$ caramelize create --config my_caramel_configuration.rb
+
+Creates an example config with the given name.
+
+$ caramelize run --config my_caramel_configuration.rb
+
+Executes the given configuration.
## Contributing to caramelize
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it