README.md in eefgilm-1.1.1 vs README.md in eefgilm-1.1.2
- old
+ new
@@ -3,34 +3,33 @@
[](https://waffle.io/enilsen16/eefgilm)
#Eefgilm: A gem for cleaning up your Gemfile
#Description:
-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.
+Eefgilm 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.
-These Gemfile best practices are all based on the [blog post](http://mcdowall.info/posts/gemfile-best-practices-and-discourse/) written by John McDowall.
+These Gemfile best practices are all loosely based on a [blog post](http://mcdowall.info/posts/gemfile-best-practices-and-discourse/) written by John McDowall.
###These best practices are:
- Consistent use of Ruby hash syntax. Use either the old hashrocket or the new Ruby 1.9 syntax, but not both.
- Consistent use of a single quoted delimiter. Use either apostrophes or quotation marks, but not both.
- No commented Gem references. If it’s commented out, it shouldn’t be there.
- Comments relating to a Gem are on the same line as the gem statement, not above.
- Group gems that are sourced from Git repos at the top. Chances are they are referencing pre-versions that will become general release and you can change the reference to be part of the General project group later.
- Group gems that are sourced from a project path after Git repo sourced Gems. These are probably gems that you might make public and thus reference in the general project gem group later.
- Group all of the General project gems together (consider using the :default group).
- Group all of the Production project gems together after the General gems.
- Group all of the Asset gems after the Production group.
- Group all of the Test related gems after the Asset gems.
- Group all of the Development related gems after the Test gems.
- Within all Gem groups, sort the references by Alphabetical order.
- When adding new gems, maintain the alphabetical ordering within the groups.
----
+- Consistent use of Ruby hash syntax. Use either the old hashrocket or the new Ruby 1.9 syntax, but not both.
+- Consistent use of a single quoted delimiter. Use either apostrophes or quotation marks, but not both.
+- No commented Gem references. If it’s commented out, it shouldn’t be there.
+- Comments relating to a Gem are on the same line as the gem statement, not above.
+- Group gems that are sourced from Git repos at the top. Chances are they are referencing pre-versions that will become general release and you can change the reference to be part of the General project group later.
+- Group gems that are sourced from a project path after Git repo sourced Gems. These are probably gems that you might make public and thus reference in the general project gem group later.
+- Group all of the General project gems together (consider using the :default group).
+- Group all of the Production project gems together after the General gems.
+- Group all of the Asset gems after the Production group.
+- Group all of the Test related gems after the Asset gems.
+- Group all of the Development related gems after the Test gems.
+- Within all Gem groups, sort the references by Alphabetical order.
+- When adding new gems, maintain the alphabetical ordering within the groups.
+
## Installation
-The simplest way to install Eefgilm is to
-Run this command:
+The simplest way to install Eefgilm is to run this command:
gem install eefgilm
Alternatively you can include it in a gem file with:
@@ -51,10 +50,10 @@
---
## Usage
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
+ eefgilm
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