README.md in lolcommits-uploldz-0.2.0 vs README.md in lolcommits-uploldz-0.3.0
- old
+ new
@@ -1,30 +1,31 @@
# Lolcommits Uploldz
[](http://rubygems.org/gems/lolcommits-uploldz)
-[](https://travis-ci.org/lolcommits/lolcommits-uploldz)
+[](https://travis-ci.com/lolcommits/lolcommits-uploldz)
[](https://depfu.com/github/lolcommits/lolcommits-uploldz)
[](https://codeclimate.com/github/lolcommits/lolcommits-uploldz/maintainability)
[](https://codeclimate.com/github/lolcommits/lolcommits-uploldz/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 plugin uploads each lolcommit to a remote server after capturing. You
-configure the plugin by setting a remote endpoint to handle the HTTP post
-request. The following params will be sent:
+This plugin uploads each lolcommit to a remote server after capturing.
+You configure the plugin by setting a remote endpoint to handle the HTTP
+post request. The following params will be sent:
-* `file` - captured lolcommit image file
+* `file` - captured lolcommit file
* `message` - the commit message
-* `repo` - repository name e.g. mroth/lolcommits
+* `repo` - repository name e.g. lolcommits/lolcommits
* `sha` - commit SHA
* `author_name` - the commit author name
* `author_email` - the commit author email address
* `key` - optional key (string) from plugin config
-You can also set an optional HTTP Basic Auth header (username and/or password).
+You can also set an optional HTTP Basic Auth header (username and/or
+password).
## Requirements
* Ruby >= 2.3
* A webcam
@@ -42,24 +43,24 @@
$ lolcommits --config -p uploldz
# set enabled to `true`
# set the remote endpoint (must begin with http(s)://)
# optionally set a key (sent in params) and/or HTTP Basic Auth credentials
-That's it! Provided the endpoint responds correctly, your next lolcommit will be
-uploaded to it. To disable use:
+That's it! Provided the endpoint responds correctly, your next lolcommit
+will be uploaded to it. To disable use:
$ lolcommits --config -p uploldz
# and set enabled to `false`
## 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.
## Tests
MiniTest is used for testing. Run the test suite with:
@@ -72,39 +73,41 @@
$ rake rdoc
## Troubles?
If you think something is broken or missing, please raise a new
-[issue](https://github.com/lolcommits/lolcommits-uploldz/issues). Take
-a moment to check it hasn't been raised in the past (and possibly closed).
+[issue](https://github.com/lolcommits/lolcommits-uploldz/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-uploldz/issues) and [pull
-requests](https://github.com/lolcommits/lolcommits-uploldz/pulls) are welcome on
-GitHub.
+Bug [reports](https://github.com/lolcommits/lolcommits-uploldz/issues)
+and [pull
+requests](https://github.com/lolcommits/lolcommits-uploldz/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.org/lolcommits/lolcommits-uploldz). Read the
+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-uploldz). Read the
[contributing
guidelines](https://github.com/lolcommits/lolcommits-uploldz/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-uploldz/blob/master/CODE_OF_CONDUCT.md)
for more details.
## License
The gem is available as open source under the terms of
[LGPL-3](https://opensource.org/licenses/LGPL-3.0).
## Links
-* [Travis CI](https://travis-ci.org/lolcommits/lolcommits-uploldz)
+* [Travis CI](https://travis-ci.com/lolcommits/lolcommits-uploldz)
* [Code Climate](https://codeclimate.com/github/lolcommits/lolcommits-uploldz)
* [Test Coverage](https://codeclimate.com/github/lolcommits/lolcommits-uploldz/coverage)
* [RDoc](http://rdoc.info/projects/lolcommits/lolcommits-uploldz)
* [Issues](http://github.com/lolcommits/lolcommits-uploldz/issues)
* [Report a bug](http://github.com/lolcommits/lolcommits-uploldz/issues/new)