README.md in taskmapper-0.9.0 vs README.md in taskmapper-1.0.0
- old
+ new
@@ -226,20 +226,25 @@
require 'taskmapper-bugzilla'
codaset = taskmapper.new(:bugzilla, {:username => "foo", :password => "bar", :url => "https://bugzilla.mozilla.org"})
The source code is located at [taskmapper-bugzilla](http://github.com/hybridgroup/taskmapper-bugzilla)
+## Taskmapper CLI
+
+For the full documentation on the CLI
+[taskmapper-cli](http://github.com/hybridgroup/taskmapper-cli)
+
## Creating a provider
Creating a provider consists of three steps:
* Run the generator like this:
tm generate myprovider
* Implement whatever is needed to connect to your desired backend
* Release it to RubyGems
### Create the Taskmapper provider
Thanks to a simple generator, it is easy to get started with a new provider. Run this from the command line:
- tm generate myprovider
+ tm generate --provider-name='myprovider'
This will generate a new skeleton provider called taskmapper-myprovider in the current directory. Create a repo from that directory, and you can start implementing your provider.
Almost all APIs are different. And so are their Ruby providers. Taskmapper attempts to create an universal API for ticket and project management systems, and thus, we need to map the functionality to the Taskmapper API. This is the providers job. The provider is the glue between Taskmapper, and the task management system's API.
Usually, your provider would rely on another library for the raw HTTP interaction. For instance, [taskmapper-lighthouse](http://github.com/hybridgroup/taskmapper-lighthouse) relies on ActiveResource in order to interact with the Lighthouse API. Look at it like this: