Skip to content

Commit 5be5886

Browse files
committed
Improve readme
1 parent e9ed37c commit 5be5886

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,16 @@ end
5656
```
5757

5858
And that's pretty much it. Just a declarative way to identify your plugin,
59-
detect whether it supports the given context (e.g. the current `runner` and
60-
`engine` and their respective `_version`s), and then provides your custom
61-
configuration as a [LintRoller::Rules](lib/lint_roller/rules.rb) object.
59+
detect whether it supports the given
60+
[LintRoller::Context](/lib/lint_roller_context.rb) (e.g. the current `runner`
61+
and `engine` and their respective `_version`s), for which the plugin will
62+
ultimately its configuration as a [LintRoller::Rules](/lib/lint_roller/rules.rb)
63+
object.
6264

6365
## Packaging a plugin in a gem
6466

65-
In order for a formatter to use your plugin, it needs to know where to what path
66-
to require and the name of your plugin class to instantiate and invoke.
67+
In order for a formatter to use your plugin, it needs to know what path to
68+
require as well as the name of the plugin class to instantiate and invoke.
6769

6870
To make this work seamlessly for your users without additional configuration of
6971
their own, all you need to do is specify a metadata attribute called

0 commit comments

Comments
 (0)