Example

This is the README file for the example gem.

Installation

# gem install example_gem

Usage

require "example"
Example.new.hi #=> Some example message on the console

License

Never forget to add a license to your code, otherwise people will
either start picking around you or not even use your code at all. If
unsure, refer to these guidelines:

1. If you want to enforce any application using your code to be
open-source’d, use the GNU GPLv3. This is a good choice for end-user
applications, but not for libraries as it prohibits most comercial
use.

2. If you want to ensure that closed-source (read: most comercial)
projects can use your library, but at the same time want to ensure
that they are forced to publish *your* code’s part in that project,
use the GNU LGPLv3.

3. If you want to let anyone do anything with your library, just
ensuring they mention your name, use the 2-Clause-BSDL. This is what
Ruby itself uses.

4. Otherwise... Well, no otherwise. You should consider all three
points above, and if they don’t serve you, refer to
http://opensource.org/licenses/index.html for a list of OSI-approved
licenses and pick one that servers you better.