diff --git a/README.md b/README.md index aa94f42..0a36652 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,10 @@ mingle_cli.rb card [number] [format] mingle_cli.rb cards [filter] [format] ``` +``` +mingle_cli.rb comment [number] [comment] +``` + ``` mingle_cli.rb comments [number] ``` @@ -30,6 +34,7 @@ mingle_cli.rb comments [number] ###Argument Definitions:### * __Number__: The card number. * __Format__: The format of the result of the command. Formats can contain property names nested in brackets which will then be replaced with the value of the property. +* __Comment__: The message to leave in the comment. * __Filter__: Mingle's MQL syntax. @@ -58,6 +63,12 @@ mingle_cli.rb cards 'status is ["in development"]' 'Number: [number] Pair: [dev Number: 19480 Pair: Homer/Bart Number: 19495 Pair: Marge/Lisa ``` +####Adding a card comment:#### + +``` +mingle_cli.rb comment 19480 'Doh!' +``` + ####Viewing card comments:#### ``` @@ -66,4 +77,4 @@ mingle_cli.rb comments 19480 ``` 2014-01-30 12:57:46 -0500 Home Simpson: Doh! -``` \ No newline at end of file +```