README.md in trellist-0.5.1 vs README.md in trellist-0.6.0
- old
+ new
@@ -1,11 +1,11 @@
# trellist
-A CLI tool for getting Trello card information in various
+A CLI tool for getting Trello card titles and links in various
formats (default: markdown).
-
+[](https://travis-ci.org/chaserx/trellist)
## Usage
The following [Trello API](https://developers.trello.com/) credentials are
required from your account:
@@ -29,13 +29,31 @@
- `trellist cards` **mardown format**
- `trellist cards --format=markdown` **same as above**
- `trellist cards --format=plain` **just links**
- `trellist cards --format=html` **html**
+#### Link prefix and suffix
+
+You can supply optional prefix and suffix flags to alter the output. However, prefix and suffix only work for markdown and HTML formats.
+
+example. `trellist cards --format=markdown --prefix='* '` will return
+
+`* [Card Title](https://trello.com/c/1moT1m3)`
+
+Similar with suffix.
+
+#### Filtering cards
+
+You can filter cards by their labels.
+
+example. `trellist cards --label='foo'`
+
## Development
- `bundle install`
-- `bundle exec bin/trellist cards`
+- `bundle exec ./bin/trellist cards` you have to use bundle exec in development mode
+
+Run `rake -T` to view helpful build and release tasks.
## Contribution
Pull requests welcome. Please follow the [contribution guide](contributing.md).