README.md in lolcommits-tumblr-0.5.0 vs README.md in lolcommits-tumblr-0.5.1
- old
+ new
@@ -4,17 +4,16 @@
[](https://travis-ci.com/lolcommits/lolcommits-tumblr)
[](https://depfu.com/github/lolcommits/lolcommits-tumblr)
[](https://codeclimate.com/github/lolcommits/lolcommits-tumblr/maintainability)
[](https://codeclimate.com/github/lolcommits/lolcommits-tumblr/test_coverage)
-[lolcommits](https://lolcommits.github.io/) takes a snapshot with your
-webcam every time you git commit code, and archives a lolcat style image
-with it. Git blame has never been so much fun!
+[lolcommits](https://lolcommits.github.io/) takes a snapshot with your webcam
+every time you git commit code, and archives a lolcat style image with it. Git
+blame has never been so much fun!
-This is a simple plugin to post lolcommits to your Tumblr. Configure it
-with a Tumblr access token and secret (the plugin will guide you through
-this process).
+This is a simple plugin to post lolcommits to your Tumblr. Configure it with a
+Tumblr access token and secret (the plugin will guide you through this process).
## Requirements
* Ruby >= 2.4
* A webcam
@@ -26,56 +25,55 @@
After installing the lolcommits gem, install this plugin with:
$ gem install lolcommits-tumblr
-Then configure to enable. If this is your first time setting up, you'll
-be asked to visit Tumblr to authenticate and allow access.
+Then configure to enable. If this is your first time setting up, you'll be asked
+to visit Tumblr to authenticate and allow access.
$ lolcommits --config -p tumblr
# set enabled to `true`
# confirm access for this plugin at tumblr.com (link opens automatically)
# click 'allow' then return to the console to set your Tumblr name
# optionally set a caption for each post (ERB friendly, see below)
# optionally set the plugin to auto-open each created Tumblr post
-That's it! Your next lolcommit will automatically be posted to your
-Tumblr blog. To disable use:
+That's it! Your next lolcommit will automatically be posted to your Tumblr blog.
+To disable use:
$ lolcommits --config -p tumblr
# and set enabled to `false`
### ERB friendly captions
-When configuring this plugin, you may optionally set a caption string to for
-each Tumblr post. The ERB bind has these variables available:
+You can optionally configure a caption string for each Tumblr post
+`caption_erb`. The ERB bind has these variables available:
* `message` - commit message string
* `sha` - commit sha (shortened)
* `branch` - commit branch name
* `repo` - vcs respository name
* `vcs_info` - [vcs_info](https://github.com/lolcommits/lolcommits/blob/master/lib/lolcommits/vcs_info.rb) instance (from lolcommits)
-Allowing you to set caption strings like this:
+This allows you to set caption strings like this:
Committed <%= sha %> in <%= repo %> on <%= branch %> - <%= message %>
## Development
-Check out this repo and run `bin/setup`, this will install all
-dependencies and generate docs. Use `bundle exec rake` to run all tests
-and generate a coverage report.
+Check out this repo and run `bin/setup`, this will install all dependencies and
+generate docs. Use `bundle exec rake` to run all tests and generate a coverage
+report.
-You can also run `bin/console` for an interactive prompt that will allow
-you to experiment with the gem code.
+You can also run `bin/console` for an interactive prompt that will allow you to
+experiment with the gem code.
-This plugin uses the
-[tumblr-client](https://github.com/tumblr/tumblr_client) and
-[OAuth](https://rubygems.org/gems/oauth/versions/0.5.3) gems. A
+This plugin uses the [tumblr-client](https://github.com/tumblr/tumblr_client)
+and [OAuth](https://rubygems.org/gems/oauth/versions/0.5.3) gems. A
[Webrick](https://rubygems.org/gems/webrick) server is started during
-configuration, to provide a responding `return_uri` for the OAuth flow
-to complete.
+configuration, to provide a responding `return_uri` for the OAuth flow to
+complete.
## Tests
MiniTest is used for testing. Run the test suite with:
@@ -88,30 +86,27 @@
$ rake rdoc
## Troubles?
If you think something is broken or missing, please raise a new
-[issue](https://github.com/lolcommits/lolcommits-tumblr/issues). Take a
-moment to check it hasn't been raised in the past (and possibly closed).
+[issue](https://github.com/lolcommits/lolcommits-tumblr/issues). Take a moment
+to check it hasn't been raised in the past (and possibly closed).
## Contributing
-Bug [reports](https://github.com/lolcommits/lolcommits-tumblr/issues)
-and [pull
-requests](https://github.com/lolcommits/lolcommits-tumblr/pulls) are
-welcome on GitHub.
+Bug [reports](https://github.com/lolcommits/lolcommits-tumblr/issues) and [pull
+requests](https://github.com/lolcommits/lolcommits-tumblr/pulls) are welcome on
+GitHub.
-When submitting pull requests, remember to add tests covering any new
-behaviour, and ensure all tests are passing on [Travis
-CI](https://travis-ci.com/lolcommits/lolcommits-tumblr). Read the
-[contributing
+When submitting pull requests, remember to add tests covering any new behaviour,
+and ensure all tests are passing on [Travis
+CI](https://travis-ci.com/lolcommits/lolcommits-tumblr). Read the [contributing
guidelines](https://github.com/lolcommits/lolcommits-tumblr/blob/master/CONTRIBUTING.md)
for more details.
-This project is intended to be a safe, welcoming space for
-collaboration, and contributors are expected to adhere to the
-[Contributor Covenant](http://contributor-covenant.org) code of conduct.
-See
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the [Contributor
+Covenant](http://contributor-covenant.org) code of conduct. See
[here](https://github.com/lolcommits/lolcommits-tumblr/blob/master/CODE_OF_CONDUCT.md)
for more details.
## License