Gem is misnamed causing additional work during implementation #114
Description
The main file in this gem is lib/stream-chat.rb. The gemspec is named stream-chat.gemspec.
The "-ruby" part of the name is redundant in a Ruby gem name. With all that in mind, the gem should have been published under the name stream-chat. That name is not in use in Rubygems, so that is currently possible.
By not having the name of the gem not matching the name of the main file, the additional step of calling `require "stream-chat" is necessary. That's not standard or expected in the Ruby world, it would only be expected if the gem has files that should only be included under limited and specific conditions, like test harnesses.
So here are two possible paths to improve this:
Change the name of the gem:
- Change the name in the gemspec file to
stream-chat - Update the README to use the new name in the Installation section, and remove the
requirecall in the Getting Started section - Publish new versions to rubygems under the new name (and potentially also the old name)
Downside of simply renaming the gem going forward is that those using the gem under the old name would no longer receive new versions of the gem, unless it's published under both names going forward.
Remove the need for an additional require call:
- Add a file named
lib/stream-chat-ruby.rbwhich callsrequire "stream-chat" - Update the README to remove the
requirecall in the Getting Started section