README.md in pushpop-keen-0.1.1 vs README.md in pushpop-keen-0.2
- old
+ new
@@ -16,10 +16,12 @@
$ gem install pushpop-keen
```
### Usage
+#### Querying
+
The `keen` plugin gives you a DSL to specify Keen query parameters. Those query parameters are used to query data using the [keen-gem](https://github.com/keenlabs/keen-gem).
Here's an example that shows many of the options you can specify:
``` ruby
@@ -40,9 +42,23 @@
end
```
A `steps` method is also supported for [funnels](https://keen.io/docs/data-analysis/funnels/),
as well as `analyses` for doing a [multi-analysis](https://keen.io/docs/data-analysis/multi-analysis/).
+
+#### Tracking
+
+You can also very simply record events to Keen:
+
+``` ruby
+job 'send pageview'
+
+ keen do
+ record 'Pageview', path: '/a/path'
+ end
+
+end
+```
The `keen` plugin requires that the following environment variables are set:
+ `KEEN_PROJECT_ID`
+ `KEEN_READ_KEY`