README.md in semantic_logger-1.0.1 vs README.md in semantic_logger-2.0.0
- old
+ new
@@ -3,10 +3,16 @@
Improved logging for Ruby
* http://github.com/ClarityServices/semantic_logger
+### Note:
+
+As of SemanticLogger V2.0 the Rails logging is no longer automatically replaced
+when including SemanticLogger. Include the [rails_semantic_logger](http://github.com/ClarityServices/rails_semantic_logger)
+to replace the Rails default logger with SemanticLogger
+
### Overview
Semantic Logger takes logging in Ruby to a new level by adding several new
capabilities to the commonly used Logging API:
@@ -431,11 +437,11 @@
logger.debug("Hello World")
# ...
end
```
-### Using SemanticLogger outside of Rails
+### Using SemanticLogger standalone
Example:
```ruby
require 'semantic_logger'
@@ -454,19 +460,19 @@
```
### Configuration
The Semantic Logger follows the principle where multiple appenders can be active
-at the same time. This allows one to log to MongoDB and the Rails
-ActiveResource::BufferedLogger at the same time.
+at the same time. For example, this allows one to log to MongoDB and the Rails
+log file at the same time.
#### Rails Configuration
Add the following line to Gemfile
```ruby
-gem 'semantic_logger'
+gem 'rails_semantic_logger'
```
Also add the following line to Gemfile if you want to log to MongoDB
```ruby
@@ -751,11 +757,10 @@
See the [MongoDB Appender Test](https://github.com/ClarityServices/semantic_logger/blob/master/test/appender_mongodb_test.rb) for an example.
### Dependencies
- Ruby MRI 1.8.7, 1.9.3 (or above) Or, JRuby 1.6.3 (or above)
-- Optional: Rails 3.0.10 (or above)
- Optional: To log to MongoDB, Mongo Ruby Driver 1.5.2 or above
### Install
gem install semantic_logger
@@ -764,15 +769,12 @@
gem install mongo
### Future
-- In V1: Move Railtie to it's own gem so that the Rails logger is not replaced
- automatically
-- In V1: Add support for a configuration file that can set log level by class name
-- Configuration file to support setting the log level for a specific class
+- Add support for a configuration file that can set log level by class name
- Configuration file to support adding appenders
-- Based on demand add appenders for: Syslog, hadoop, redis
+- Based on end-user demand add appenders for: Syslog, hadoop, redis, etc..
Development
-----------
Want to contribute to Semantic Logger?