README.md in scrum_lint-0.0.1 vs README.md in scrum_lint-0.0.2

- old
+ new

@@ -10,13 +10,14 @@ gem install scrum_lint ``` ## Usage -ScrumLint expects the environment variables `TRELLO_DEVELOPER_PUBLIC_KEY` and -`TRELLO_MEMBER_TOKEN` to be set in order to work. You can see how to acquire -these tokens in the [Basic authorization section of the `ruby-trello` +ScrumLint expects a `.scrum-lint.yml` file in the current working directory +with at a minimum a `trello_developer_public_key` and `trello_member_token`. +You can see how to acquire these tokens in the ["Basic authorization" section +of the `ruby-trello` gem](https://github.com/jeremytregunna/ruby-trello#basic-authorization). Once you've set these, you can run the following command for a list of corrections to be made: ```sh @@ -26,17 +27,17 @@ Running ScrumLint will run a series of checks against your Trello board to ensure it is up to date, and list out any violations. ## Linters -### Context +**Context** -The Context linter checks that each card in task lists has a context listed at +The Context linter checks that each card in task lists has a context link at the beginning of it's description. This is expected to be a text label in the format: ``` -Context: https://trello.com/c/<some_card_hash> +Context: <link to a Trello card> ``` ## Development After checking out the repo, run `script/setup` to install dependencies. Then,