README.md in eefgilm-0.0.5 vs README.md in eefgilm-1.0.0
- old
+ new
@@ -1,32 +1,91 @@
+[](https://travis-ci.org/enilsen16/Eefgilm)
+[](http://badge.fury.io/rb/eefgilm)
[](https://waffle.io/enilsen16/eefgilm)
#Eefgilm: A gem for cleaning up your Gemfile
#Description:
-This gem automatically sorts the Gemfile alphabetically and removes comments, per Best Practice. Grouped gems are only sorted within their group.
+**Important, currently does not support group blocks. If you have groups they will not included in the revised gemfile!**
+This gem automatically modifies a ruby gemfile to make them a little easier to read, it does this by alphabetizing the gems, removing all comments, and removing all whitespace including leading and trailing.
+---
+
## Installation
+The simplest way to install Eefgilm is to
+Run this command:
-Add this line to your application's Gemfile:
+ gem install eefgilm
- gem 'eefgilm'
+Alternatively you can include it in a gem file with:
-And then execute:
+ gem 'eefgilm'
- $ bundle
+and then run
-Or install it yourself as:
+ bundle install
- $ gem install eefgilm
-
+---
## Usage
-TODO: Write usage instructions here
+Once you have installed eefgilm on your system or in a project directory its quite simple to use. In the directory who's gemfile you would like to modify run:
+ eefglim
+
+Currently it will not ask you for any confirmation before making modifications, nor will it create a backup so please be careful when using eefgilm. It may be a good idea to backup your gemfile beforehand hand this can be done with:
+
+ cp Gemfile Gemfilebackup
+
+---
## Contributing
+We welcome contributions! If you want to help out you have many options:
1. Fork it ( https://github.com/enilsen16/eefgilm/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
+
+---
+##Issues
+If you find a bug or have a suggestion, please create a new issue and we will look into it. Thank You.
+[Create a new issue](https://github.com/enilsen16/Eefgilm/issues/new)
+
+---
+##Contact
+
+
+---
+
+##Thanks
+The following people have helped with development or project design in one form or another:
+[Steve Buckley](https://github.com/buckleys78)
+[Brook Riggio](https://github.com/brookr)
+[Cheri](https://github.com/cherimarie)
+[David](https://github.com/dbalatero)
+
+---
+##License
+
+And now for the fun part...
+
+The MIT License (MIT)
+
+Copyright (c) <2014> <Marco Lindsay & Erik Nilsen>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.