chiu
/
impressionist
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

new readme format

This commit is contained in:
cowboycoded 2011-03-08 13:23:42 -05:00
parent 6d6e4cb7ad
commit 9f1bd35f3a
1 changed files with 62 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.rdoc → README.md
View File

@ -1,28 +1,31 @@
= impressionist ![Impressionist Logo](https://github.com/cowboycoded/impressionist/raw/master/logo.png)
impressionist
=============
A lightweight plugin that logs impressions per action or manually per model A lightweight plugin that logs impressions per action or manually per model
== I would not call this a stable plugin yet, although I have been running it in prod with no problems. Use at your own risk ;-) I would not call this a stable plugin yet, although I have been running it in prod with no problems. Use at your own risk ;-)
------------------------------------------------------------------------------------------------------------------------------
== What does this thing do?
What does this thing do?
------------------------
Logs an impression... and I use that term loosely. It can log page impressions (technically action impressions), but it is not limited to that. Logs an impression... and I use that term loosely. It can log page impressions (technically action impressions), but it is not limited to that.
You can log impressions multiple times per request. And you can also attach it to a model. The goal of this project is to provide customizable You can log impressions multiple times per request. And you can also attach it to a model. The goal of this project is to provide customizable
stats that are immediately accessible in your application as opposed to using G Analytics and pulling data using their API. You can attach custom stats that are immediately accessible in your application as opposed to using G Analytics and pulling data using their API. You can attach custom
messages to impressions. No reporting yet.. this thingy just creates the data. messages to impressions. No reporting yet.. this thingy just creates the data.
== What about bots? What about bots?
----------------
They are ignored. 1200 known bots have been added to the ignore list as of Feb 1, 2011. Impressionist uses this list: They are ignored. 1200 known bots have been added to the ignore list as of Feb 1, 2011. Impressionist uses this list:
http://www.user-agents.org/allagents.xml http://www.user-agents.org/allagents.xml
Which versions of Rails and Ruby is this compatible with?
== Which versions of Rails and Ruby is this compatible with? ---------------------------------------------------------
Rails 3.0.4 and Ruby 1.9.2 (also tested on REE 1.8.7) - Sorry, but you need to upgrade if you are using Rails 2. You know you want to anyways.. all the cool kids are doing it ;-) Rails 3.0.4 and Ruby 1.9.2 (also tested on REE 1.8.7) - Sorry, but you need to upgrade if you are using Rails 2. You know you want to anyways.. all the cool kids are doing it ;-)
== Installation Installation
------------
Add it to your Gemfile Add it to your Gemfile
gem 'impressionist' gem 'impressionist'
@ -53,8 +56,8 @@ The following fields are provided in the migration:
t.datetime "created_at" # I am not sure what this is.... Any clue? t.datetime "created_at" # I am not sure what this is.... Any clue?
t.datetime "updated_at" # never seen this one before either.... Your guess is as good as mine?? t.datetime "updated_at" # never seen this one before either.... Your guess is as good as mine??
== Usage Usage
-----
1. Log all actions in a controller 1. Log all actions in a controller
@ -104,14 +107,15 @@ The following fields are provided in the migration:
Logging impressions for authenticated users happens automatically. If you have a current_user helper or use @current_user in your before_filter to set your authenticated user, current_user.id will be written to the user_id field in the impressions table. Logging impressions for authenticated users happens automatically. If you have a current_user helper or use @current_user in your before_filter to set your authenticated user, current_user.id will be written to the user_id field in the impressions table.
== Development Roadmap Development Roadmap
-------------------
* Automatic impression logging in views. For example, log initial view, and any partials called from initial view * Automatic impression logging in views. For example, log initial view, and any partials called from initial view
* Customizable black list for user-agents or IP addresses. Impressions will be ignored. Web admin as part of the Engine. * Customizable black list for user-agents or IP addresses. Impressions will be ignored. Web admin as part of the Engine.
* Reporting engine * Reporting engine
* AB testing integration * AB testing integration
== Contributing to impressionist Contributing to impressionist
-----------------------------
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project * Fork the project
@ -120,8 +124,9 @@ Logging impressions for authenticated users happens automatically. If you have
* Make sure to add rpsec tests for it. Patches or features without tests will be ignored. Also, try to write better tests than I do ;-) * Make sure to add rpsec tests for it. Patches or features without tests will be ignored. Also, try to write better tests than I do ;-)
* If adding engine controller or view functionality, use HAML and Inherited Resources. * If adding engine controller or view functionality, use HAML and Inherited Resources.
* All testing is done inside a small Rails app (test_app). You will find specs within this app. * All testing is done inside a small Rails app (test_app). You will find specs within this app.
== Copyright
Copyright
---------
Copyright (c) 2011 cowboycoded. See LICENSE.txt for Copyright (c) 2011 cowboycoded. See LICENSE.txt for
further details. further details.