Contents

# AnnotateGem

`annotate_gem` is command line tool that will add useful comments to your Gemfile. For each gem, `annotate_gem` will create a comment with the gem's description and the gem's website. For example, a Gemfile containing the following

```ruby
gem "rails"
gem "nokogiri"
gem "brakeman"
```

will be converted into something that is more descriptive and is self-documenting:

```ruby
# Full-stack web application framework. (http://www.rubyonrails.org)
gem "rails"
# Nokogiri (鋸) is an HTML, XML, SAX, and Reader parser (http://nokogiri.org)
gem "nokogiri"
# Security vulnerability scanner for Ruby on Rails. (http://brakemanscanner.org)
gem "brakeman"
```

The motivation for `annotate_gem` is that developers often open a Gemfile and not know what many of the listed gems are actually for. It's hard to track down which gem is providing which functionality. This is a common problem since many gem names do not reflect the actual feature.

If you do _not_ want to install the gem, you can also visit <https://annotate_gem.herokuapp.com/> which is a web interface for `annotate_gem`.

## Installation

```
$ gem install annotate_gem
```

## Usage

Running `annotate_gem` itself will add comments to the current directory's `Gemfile`.

```
$ cat Gemfile
source 'https://rubygems.org'
gem "pry"
$ annotate_gem
$ cat Gemfile
source 'https://rubygems.org'
# An IRB alternative and runtime developer console (http://pryrepl.org)
gem "pry"
```

`annotate_gem` has several options and you can see them via `annotate_gem -h`. `annotate_gem` also works with specifying a single gem name:

```
$ annotate_gem aasm
State machine mixin for Ruby objects (https://github.com/aasm/aasm)
```

## Contributing

1. Fork it ( https://github.com/ivantsepp/annotate_gem/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
annotate_gem-0.0.8	README.md