README.md in peek-0.1.8 vs README.md in peek-0.1.9
- old
+ new
@@ -1,8 +1,8 @@
# Peek
-[](https://travis-ci.org/peek/peek) [](http://badge.fury.io/rb/peek)
+[](https://travis-ci.org/peek/peek) [](http://badge.fury.io/rb/peek) [](http://inch-ci.org/github/peek/peek)
Take a peek into your Rails application.
@@ -43,11 +43,11 @@
Peek.into Peek::Views::Mysql2
Peek.into Peek::Views::Redis
Peek.into Peek::Views::Dalli
```
-Feel free to pick and choose from the list or create your own. The order they
+Feel free to pick and install from the [list](https://github.com/peek/peek#available-peek-views) or create your own. The order they
are added to Peek, the order they will appear in your bar.
Next, to render the Peek bar in your application just add the following snippet
just after the opening `<body>` tag in your application layout.
@@ -109,10 +109,11 @@
Note: Peek does not provide the dependencies for each of these adapters. If you use these
adapters be sure to include their dependencies in your application.
- Redis - The [redis](https://github.com/redis/redis-rb) gem
- Dalli - The [dalli](https://github.com/mperham/dalli) gem
+- Elasticsearch - The [elasticsearch](https://github.com/elasticsearch/elasticsearch-ruby) gem
```ruby
Peeked::Application.configure do
# ...
@@ -132,19 +133,46 @@
config.peek.adapter = :memcache, {
:client => Dalli::Client.new,
:expires_in => 60 * 30 # => 30 minutes in seconds
}
+ # Elasticsearch with no options
+ config.peek.adapter = :elasticsearch
+
+ # Elasticsearch with options
+ config.peek.adapter = :elasticsearch, {
+ :client => Elasticsearch::Client.new,
+ :expires_in => 60 * 30, # => 30 minutes in seconds
+ :index => 'peek_requests_index',
+ :type => 'peek_request'
+ }
+
# ...
end
```
Peek doesn't persist the request data forever. It uses a safe 30 minute
cache length that way data will be available if you'd like to aggregate it or
use it for other Peek views. You can update this to be 30 seconds if you don't
want the data to be available to stick around.
+### Customizing the bar
+
+You can customize the appearance of the bar by customizing it in your own application's CSS.
+
+One common example is fixing the peek bar to the bottom, rather than top, of a page, for use with [Bootstrap](http://getbootstrap.com/):
+
+```css
+#peek {
+ position: fixed;
+ bottom: 0;
+ left: 0;
+ right: 0;
+ z-index: 999;
+}
+```
+
## Using Peek with PJAX
It just works.
## Using Peek with Turbolinks
@@ -165,13 +193,15 @@
end
```
## Available Peek views
+- [peek-active_resource](https://github.com/gotmayonase/peek-active_resource)
- [peek-dalli](https://github.com/peek/peek-dalli)
- [peek-gc](https://github.com/peek/peek-gc)
- [peek-git](https://github.com/peek/peek-git)
- [peek-mongo](https://github.com/peek/peek-mongo)
+- [peek-moped](https://github.com/nodkz/peek-moped)
- [peek-mysql2](https://github.com/peek/peek-mysql2)
- [peek-performance_bar](https://github.com/peek/peek-performance_bar)
- [peek-pg](https://github.com/peek/peek-pg)
- [peek-rblineprof](https://github.com/peek/peek-rblineprof)
- [peek-redis](https://github.com/peek/peek-redis)