📝 Improved documentation

pboling · Sep 25, 2023 · 04b4bc8 · 04b4bc8
1 parent 3ec5a3d
commit 04b4bc8
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 24 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -7,6 +7,10 @@ the [code of conduct][conduct].
 To submit a patch, please fork the project and create a patch with tests. Once you're happy with it send a pull request
 and post a message to the [gitter chat][🏘chat].
 
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
 ## Release
 
 To release a new version:
@@ -29,12 +33,14 @@ See: [RubyGems Security Guide][rubygems-security-guide]
 
 ## Contributors
 
-See: [https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/graphs/main][🖐contributors]
+[![Contributors](https://contrib.rocks/image?repo=pboling/gitmoji-regex)][🖐contributors]
 
-[conduct]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/blob/main/CODE_OF_CONDUCT.md
-[🖐contributors]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/graphs/main
-[🚎src-main]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/tree/main
-[🏘chat]: https://gitter.im/rubocop-lts/community
+Made with [contributors-img][contrib-rocks].
+
+[🖐contributors]: https://github.com/pboling/gem_bench/graphs/contributors
+[contrib-rocks]: https://contrib.rocks
+[conduct]: https://github.com/pboling/gem_bench/blob/main/CODE_OF_CONDUCT.md
+[🚎src-main]: https://github.com/pboling/gem_bench/tree/main
+[🏘chat]: https://matrix.to/#/%23pboling_gem_bench:gitter.im
 [rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
 [rubygems]: https://rubygems.org
-
diff --git a/README.md b/README.md
@@ -7,22 +7,22 @@
 Gem: "Put me in coach!"
 You: ❨╯°□°❩╯︵┻━┻
 
-| Project                 |  GemBench               |
-|------------------------ | ----------------------- |
-| gem name                |  [gem_bench](https://rubygems.org/gems/gem_bench) |
-| license                 |  [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) |
-| download rank           |  [![Downloads Today](https://img.shields.io/gem/rd/gem_bench.svg)](https://github.com/pboling/gem_bench) |
-| version                 |  [![Version](https://img.shields.io/gem/v/gem_bench.svg)](https://rubygems.org/gems/gem_bench) |
-| dependencies            |  [![Depfu](https://badges.depfu.com/badges/865e7bb1d0d3eb3ba807fca7344e22d1/overview.svg)](https://depfu.com/github/pboling/gem_bench?project_id=5613) |
-| continuous integration  |  [![Current][🚎cwfi]][🚎cwf] [![Heads][🖐hwfi]][🖐hwf] [![Style][🧮swfi]][🧮swf] [![Coverage][📗cov-wfi]][📗cov-wf]|
-| test coverage           |  [![Test Coverage](https://api.codeclimate.com/v1/badges/80787f126e7a486b19af/test_coverage)](https://codeclimate.com/github/pboling/gem_bench/test_coverage) |
-| maintainability         |  [![Maintainability](https://api.codeclimate.com/v1/badges/80787f126e7a486b19af/maintainability)](https://codeclimate.com/github/pboling/gem_bench/maintainability) |
-| code triage             |  [![Open Source Helpers](https://www.codetriage.com/pboling/gem_bench/badges/users.svg)](https://www.codetriage.com/pboling/gem_bench) |
-| homepage                |  [on Github.com][homepage] |
-| documentation           |  [on Rdoc.info][documentation] |
-| live chat               |  [![Join the chat at https://gitter.im/pboling/gem_bench](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/pboling/gem_bench?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
-| expert support          |  [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github) |
-| Spread ~♡ⓛⓞⓥⓔ♡~      |  [🌏](https://about.me/peter.boling), [👼](https://angel.co/peter-boling), [![Tweet Peter](https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow)](http://twitter.com/galtzo) |
+| Project                | GemBench                                                                                                                                                                                             |
+|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| gem name               | [gem_bench](https://rubygems.org/gems/gem_bench)                                                                                                                                                     |
+| license                | [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)                                                                                           |
+| download rank          | [![Downloads Today](https://img.shields.io/gem/rd/gem_bench.svg)](https://github.com/pboling/gem_bench)                                                                                              |
+| version                | [![Version](https://img.shields.io/gem/v/gem_bench.svg)](https://rubygems.org/gems/gem_bench)                                                                                                        |
+| dependencies           | [![Depfu](https://badges.depfu.com/badges/865e7bb1d0d3eb3ba807fca7344e22d1/overview.svg)](https://depfu.com/github/pboling/gem_bench?project_id=5613)                                                |
+| continuous integration | [![Current][🚎cwfi]][🚎cwf] [![Heads][🖐hwfi]][🖐hwf] [![Style][🧮swfi]][🧮swf] [![Coverage][📗cov-wfi]][📗cov-wf]                                                                                   |
+| test coverage          | [![Test Coverage](https://api.codeclimate.com/v1/badges/80787f126e7a486b19af/test_coverage)](https://codeclimate.com/github/pboling/gem_bench/test_coverage)                                         |
+| maintainability        | [![Maintainability](https://api.codeclimate.com/v1/badges/80787f126e7a486b19af/maintainability)](https://codeclimate.com/github/pboling/gem_bench/maintainability)                                   |
+| code triage            | [![Open Source Helpers](https://www.codetriage.com/pboling/gem_bench/badges/users.svg)](https://www.codetriage.com/pboling/gem_bench)                                                                |
+| homepage               | [on Github.com][homepage]                                                                                                                                                                            |
+| documentation          | [on Rdoc.info][documentation]                                                                                                                                                                        |
+| live chat              | [![Join the chat][🏘chati]][🏘chat]                                                                                                                                                                         |
+| expert support         | [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github) |
+| Spread ~♡ⓛⓞⓥⓔ♡~        | [🌏](https://about.me/peter.boling), [👼](https://angel.co/peter-boling), [![Tweet Peter](https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow)](http://twitter.com/galtzo)    |
 
 [🚎cwf]: https://github.com/rubocop-lts/rubocop-lts/actions/workflows/current.yml
 [🚎cwfi]: https://github.com/rubocop-lts/rubocop-lts/actions/workflows/current.yml/badge.svg
@@ -32,6 +32,8 @@ You: ❨╯°□°❩╯︵┻━┻
 [🧮swfi]: https://github.com/rubocop-lts/rubocop-lts/actions/workflows/style.yml/badge.svg
 [📗cov-wf]: https://github.com/rubocop-lts/rubocop-lts/actions/workflows/coverage.yml
 [📗cov-wfi]: https://github.com/rubocop-lts/rubocop-lts/actions/workflows/coverage.yml/badge.svg
+[🏘chat]: https://matrix.to/#/%23pboling_gem_bench:gitter.im
+[🏘chati]: https://badges.gitter.im/Join%20Chat.svg
 
 ### New for 2.0.0 - Dropped Support for Ruby 2.0, 2.1, 2.2
 
@@ -378,9 +380,14 @@ How much faster will my app boot loading 45 fewer gems?  A bit.
 This gem determines which gems need to be loaded at Rails' boot time by looking for Railties and Engines.
 A future version will also look for initializers, because gems which have code that runs (e.g. configuration) in an initializer also need to be loaded at boot time.
 
-## Development
+## Contributors
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+[![Contributors](https://contrib.rocks/image?repo=pboling/gitmoji-regex)][🖐contributors]
+
+Made with [contributors-img][contrib-rocks].
+
+[🖐contributors]: https://github.com/pboling/gem_bench/graphs/contributors
+[contrib-rocks]: https://contrib.rocks
 
 ## Contributing