README.md in keen-1.1.0 vs README.md in keen-1.1.1

- old
+ new

@@ -173,10 +173,20 @@ Each query method or alias takes an optional hash of options as an additional parameter. Possible keys are: `:response` – Set to `:all_keys` to return the full API response (usually only the value of the `"result"` key is returned). `:method` - Set to `:post` to enable post body based query (https://keen.io/docs/data-analysis/post-queries/). +##### Query Logging + +You can log all GET and POST queries automatically by setting the `log_queries` option. + +``` ruby +Keen.log_queries = true +Keen.count('purchases') +# I, [2016-10-30T11:45:24.678745 #9978] INFO -- : [KEEN] Send GET query to https://api.keen.io/3.0/projects/<YOUR_PROJECT_ID>/queries/count?event_collection=purchases with options {} +``` + ### Saved Queries You can manage your saved queries from the Keen ruby client. ```ruby @@ -445,10 +455,14 @@ If you want some bot protection, check out the [Voight-Kampff](https://github.com/biola/Voight-Kampff) gem. Use the gem's `request.bot?` method to detect bots and avoid logging events. ### Changelog +##### 1.1.1 ++ Added an option to log queries ++ Added a cli option that includes the Keen code + ##### 1.1.0 + Add support for access keys + Move saved queries into the Keen namespace + Deprecate scoped keys in favor of access keys @@ -600,12 +614,23 @@ `bundle exec guard -g integration` `bundle exec guard -g synchrony` +#### Running a Local Console + +You can spawn an `irb` session with the local files already loaded for debugging +or experimentation. + +``` +$ bundle exec rake console +2.2.6 :001 > Keen + => Keen +``` ### Community Contributors + [alexkwolfe](https://github.com/alexkwolfe) + [peteygao](https://github.com/peteygao) + [obieq](https://github.com/obieq) + [cbartlett](https://github.com/cbartlett) ++ [myrridin](https://github.com/myrridin) Thanks everyone, you rock!