growth 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad05187a7ece1917e916d106c71107e14f64b87e
-  data.tar.gz: e6840405f5e6d145b3409ff95627f1cf74640f59
+  metadata.gz: 06f71b3935bbf31808204ba8d6d2ab9f1641e028
+  data.tar.gz: 6c856d1bb9a2e76b70f9fbddd3deb701c93662b1
 SHA512:
-  metadata.gz: 69d0f1a05ac2d6dd61b792ed4302e0c44181f7d8e506a31431a0392273400293344133d1b90d7b0e289ca1066b029c64f03161eec662d93be7f68c6114995280
-  data.tar.gz: b20f2600913b3385ddbb27c1d26a57aa0aebe57c856ec935b5d117301f9024dbd2dae3b47818d3e9462008c81cc66d86a26ee094342399b0071e795a10742e14
+  metadata.gz: 53a0947ea53850496f0d35ed2ab6be78dd2056d39ec2012eb8be4affeb5d2ccc78ed6a124f2353c14fbb8f281588e1ec0a0becb443d1ad05f30dd6845a6d30ac
+  data.tar.gz: db3095350810c721358ff4d2b0d48838ae40c16dfdcded50b1b5f47cc6aaa286fb4ad21d13c4dc48a8ce80e7bd49c2d2cd9dc0fcfab9670f5c6ebc21d576a774

data/README.md

@@ -1,33 +1,31 @@
-# Grower
-Measure growth in your Rails models through charts and informational tables and custom views.
+# GrowthEngine
+Measure the yearly and monthly growth of your Rails models with a dashboard mounted on your Rails app.  Specify the models you'd like to measure in a single initializer file and that's it, the gem will handle the rest.
 
-## Usage
-How to use my plugin.
+A more advanced feature in the gem allows you to better understand the associations between your models.  For example, let's say you have a Users model that has_many Posts.  Over time you might wonder, how many users have only created one post?  Which user has created the most posts?  Rather than write these database queries each time, the growth gem will automatically generate these reports for you.
 
 ## Installation
-Add this line to your application's Gemfile:
-
+Add the following line to your Gemfile:
 ```ruby
 gem 'growth'
 ```
 
-And then execute:
+Then run:
 ```bash
 $ bundle install
 ```
 
-Next, you need to run the install generator:
+Next, you need to run the generator:
 ```bash
 $ rails generate growth:install
 ```
 
 Running the install generator does two things:
 
-1. Mounts the stats engine at '/stats' by adding to your routes.rb
+1. Mounts the stats engine at '/growth' by adding to your routes.rb.  You can also pass a route of your choice to the 'at' param.
 
 ```ruby
 Rails.application.routes.draw do
-  mount Growth::Engine, at: "/stats"
+  mount Growth::Engine, at: "/growth"
 end
 ```
 
@@ -37,16 +35,21 @@ end
 Growth.models_to_measure = ApplicationRecord.descendants.map { |model| model.to_s }
 ```
 
-```Growth.models_to_measure ``` takes an array of models as strings, ex. ["Posts", "Users", "Comments"], that you'd like to measure.  The default measures all models.
+You can customize the models you'd like to measure by passing an array of models, i.e.:
 
-```Growth.model_blacklist``` takes an array of models as strings, ex. ["AdminUsers"], that you want to prevent the gem from measuring.
+```ruby
+Growth.models_to_measure = [ Users, Posts, Comments ]
+```
 
-```Growth.username ``` is your username for http_basic_auth
-```Growth.password``` is your password for http_basic_auth
+Options in your config file are:
 
+```Growth.models_to_measure``` takes an array of models, ex. [Posts, Users, Comments], that you'd like to measure.  The default measures all models.
 
-## Contributing
-Contribution directions go here.
+```Growth.model_blacklist``` takes an array of models, ex. [AdminUsers], that you want to prevent the gem from measuring.
+
+```Growth.username ``` is your username for http_basic_auth
+
+```Growth.password``` is your password for http_basic_auth
 
 ## License
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+Please see <a href="https://github.com/VibrantLight/growth/blob/master/LICENSE">LICENSE</a> for licensing details.

data/lib/growth/version.rb

@@ -1,3 +1,3 @@
 module Growth
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: growth
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Ryan Friedman
@@ -80,15 +80,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A beautiful dashboard displaying the monthly and yearly growth of your
-  Rails models.
+description: Track the monthly and yearly growth of your Rails models along with their
+  associations.
 email:
 - ryan@soundtribe.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
 - README.md
 - Rakefile
 - app/assets/config/growth_manifest.js
@@ -121,7 +120,7 @@ files:
 - lib/growth/transactions/generate_retention_report.rb
 - lib/growth/version.rb
 - lib/tasks/growth_tasks.rake
-homepage: http://vibrantlight.co
+homepage: https://github.com/VibrantLight/growth
 licenses:
 - MIT
 metadata: {}

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2018 Ryan Friedman
-
-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.