guibranco / BancosBrasileiros

🇧🇷 :bank: :clipboard: Brazilian banks list
https://guibranco.github.io/BancosBrasileiros/
The Unlicense
434 stars 164 forks source link

[FEATURE] Add support to a `RubyGems` - Ruby #433

Open guibranco opened 3 months ago

guibranco commented 3 months ago

Description

We need to create a Ruby gem for this repository and publish it to RubyGems, Ruby’s official package registry. Packaging the repository as a gem will simplify distribution, version management, and integration for Ruby developers.

Why We Need This

  1. Easy Installation: Publishing the repository as a gem allows developers to install it using gem install <gem_name>, making it straightforward to integrate into Ruby applications.
  2. Version Control: RubyGems supports versioning, which helps developers specify and manage dependencies more effectively.
  3. Distribution: By publishing to RubyGems, the gem becomes available to the broader Ruby community, enhancing its visibility and usability.

Steps to Proceed

Follow these steps to create and publish the repository as a Ruby gem:

  1. Prepare the gemspec File:

    • Create a .gemspec file in the root directory of your project. This file should include metadata such as the gem name, version, summary, description, author, license, and any dependencies.
    • Refer to the RubyGems documentation for detailed instructions on setting up the .gemspec file.
  2. Create a Rakefile (Optional but Recommended):

    • A Rakefile can be used to automate tasks such as building and publishing the gem. It’s a best practice for managing gem tasks.
  3. Build the Gem:

    • Run the following command to build the gem from the .gemspec file:
      gem build <your_gem>.gemspec
    • This will create a .gem file in the current directory.
  4. Push the Gem to RubyGems:

    • Ensure you have a RubyGems account.
    • Use the following command to push the gem to RubyGems:
      gem push <your_gem>-<version>.gem
    • Detailed instructions on publishing gems can be found here.
  5. Update Documentation:

    • Ensure the README file includes usage instructions and any necessary setup information for the gem.
    • Add a badge to the README that links to the RubyGems page for the gem.

Additional Notes

Tech notes

Additional information

@EltonSantos has already made some progress on this feature. I am waiting for him to update the readme with his project.

RubyGems Bancos Brasileiros

guibranco commented 3 months ago

As discussed by email with @eltonsantos, I will go ahead with the feature. We will add the code from Elton's repository to this repository.