Skip to content

Commit 9068111

Browse files
committed
Actualize README
1 parent 6de8763 commit 9068111

File tree

3 files changed

+7
-10
lines changed

3 files changed

+7
-10
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## [Unreleased]
22

3-
## [0.1.0] - 2024-03-14
3+
## [1.0.0] - 2024-07-03
44

55
- Initial release

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,13 @@ This gem enforces consistency by checking descriptions against the described obj
3535

3636
## Installation
3737

38-
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.
39-
4038
Install the gem and add to the application's Gemfile by executing:
4139

42-
$ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
40+
$ bundle add rspec-description_consistency
4341

4442
If bundler is not being used to manage dependencies, install the gem by executing:
4543

46-
$ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
44+
$ gem install rspec-description_consistency
4745

4846
## Usage
4947

@@ -95,12 +93,12 @@ To install this gem onto your local machine, run `bundle exec rake install`.
9593

9694
## Contributing
9795

98-
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).
96+
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).
9997

10098
## License
10199

102100
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
103101

104102
## Code of Conduct
105103

106-
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).
104+
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).

rspec-description_consistency.gemspec

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,8 @@ Gem::Specification.new do |spec|
1616
spec.license = 'MIT'
1717
spec.required_ruby_version = '>= 3.0.0'
1818

19-
spec.metadata['homepage_uri'] = spec.homepage
20-
spec.metadata['source_code_uri'] = 'https://github.com/viralpraxis/rspec-description_consistency'
21-
spec.metadata['changelog_uri'] = 'https://github.com/viralpraxis/rspec-description_consistency/blob/master/CHANGELOG.md'
19+
spec.metadata['homepage_uri'] = 'https://github.com/viralpraxis/rspec-description_consistency'
20+
spec.metadata['changelog_uri'] = 'https://github.com/viralpraxis/rspec-description_consistency/blob/main/CHANGELOG.md'
2221

2322
# Specify which files should be added to the gem when it is released.
2423
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.

0 commit comments

Comments
 (0)