edit documentation

README.md

@@ -1,19 +1,30 @@
 # Bundler::VersionsReport
 
-[Bundler][bundler] plugin extending `bundle update` with a report of gems updated by a major or minor version.
+[Bundler][bundler] plugin extending the output of `bundle update` with a report of gems
+updated by a major or minor version.
 
-(We assume [semantic versioning][semver] and consider patch version updates safe and harmless.)
+We assume [semantic versioning][semver]: major version updates definitely deserve attention;
+minor version ones should be backward-compatible, but may be worth attention nevertheless;
+updates beyond the major and minor version are considered harmless.
 
-## Usage
-
-In your `Gemfile`:
-
-```ruby
-plugin 'bundler-versions_report', github: 'igneus/bundler-versions_report'
 ```
+MINOR version updates:
+- builder 3.2.4 -> 3.3.0 (by 1 minor versions)
+- concurrent-ruby 1.2.3 -> 1.3.5 (by 1 minor versions)
+- dry-inflector 1.0.0 -> 1.2.0 (by 2 minor versions)
+- jbuilder 2.11.5 -> 2.13.0 (by 2 minor versions)
+- loofah 2.22.0 -> 2.24.0 (by 2 minor versions)
+- rouge 4.2.1 -> 4.5.1 (by 3 minor versions)
+- tilt 2.3.0 -> 2.6.0 (by 3 minor versions)
+- tins 1.32.1 -> 1.38.0 (by 6 minor versions)
+
+MAJOR version updates:
+- rspec-rails 6.1.2 -> 7.1.0 (by 1 major versions)
+```
+
+## Installation
 
-Then at the end of any `bundle update` invocation which updates any gem by a major or minor version
-a listing of such gems is printed.
+`$ bundle plugin install bundler-versions_report`
 
 ## Development
 

bundler-versions_report.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["Jakub Pavlík"]
   spec.email = ["[email protected]"]
 
-  spec.summary = "Bundler plugin extending 'bundle update' with a report of major and minor version updates"
-  spec.description = ""
+  spec.summary = "Bundler plugin extending 'bundle update' with a report of gems updated by a major or minor version"
+  # spec.description = ""
   spec.homepage = "https://github.com/igneus/bundler-versions_report"
   spec.required_ruby_version = ">= 2.6.0"