From 9068111263e40935406a3a7e115aae355ce7505f Mon Sep 17 00:00:00 2001 From: viralpraxis Date: Wed, 3 Jul 2024 08:25:55 +0300 Subject: [PATCH] Actualize README --- CHANGELOG.md | 2 +- README.md | 10 ++++------ rspec-description_consistency.gemspec | 5 ++--- 3 files changed, 7 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 18ed678..ad5b2f6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,5 @@ ## [Unreleased] -## [0.1.0] - 2024-03-14 +## [1.0.0] - 2024-07-03 - Initial release diff --git a/README.md b/README.md index 1e0b53e..fc771fa 100644 --- a/README.md +++ b/README.md @@ -35,15 +35,13 @@ This gem enforces consistency by checking descriptions against the described obj ## Installation -TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org. - Install the gem and add to the application's Gemfile by executing: - $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG + $ bundle add rspec-description_consistency If bundler is not being used to manage dependencies, install the gem by executing: - $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG + $ gem install rspec-description_consistency ## Usage @@ -95,7 +93,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rspec-description_consistency. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rspec-description_consistency/blob/master/CODE_OF_CONDUCT.md). +Bug reports and pull requests are welcome on GitHub at https://github.com/viralpraxis/rspec-description_consistency. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/viralpraxis/rspec-description_consistency/blob/main/CODE_OF_CONDUCT.md). ## License @@ -103,4 +101,4 @@ The gem is available as open source under the terms of the [MIT License](https:/ ## Code of Conduct -Everyone interacting in the Rspec::DescriptionConsistency project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rspec-description_consistency/blob/master/CODE_OF_CONDUCT.md). +Everyone interacting in the Rspec::DescriptionConsistency project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/viralpraxis/rspec-description_consistency/blob/main/CODE_OF_CONDUCT.md). diff --git a/rspec-description_consistency.gemspec b/rspec-description_consistency.gemspec index 4bd537f..c34bb85 100644 --- a/rspec-description_consistency.gemspec +++ b/rspec-description_consistency.gemspec @@ -16,9 +16,8 @@ Gem::Specification.new do |spec| spec.license = 'MIT' spec.required_ruby_version = '>= 3.0.0' - spec.metadata['homepage_uri'] = spec.homepage - spec.metadata['source_code_uri'] = 'https://github.com/viralpraxis/rspec-description_consistency' - spec.metadata['changelog_uri'] = 'https://github.com/viralpraxis/rspec-description_consistency/blob/master/CHANGELOG.md' + spec.metadata['homepage_uri'] = 'https://github.com/viralpraxis/rspec-description_consistency' + spec.metadata['changelog_uri'] = 'https://github.com/viralpraxis/rspec-description_consistency/blob/main/CHANGELOG.md' # Specify which files should be added to the gem when it is released. # The `git ls-files -z` loads the files in the RubyGem that have been added into git.