README.md in tee_logger-3.1.2 vs README.md in tee_logger-3.2.0
- old
+ new
@@ -1,13 +1,13 @@
-[](http://badge.fury.io/rb/tee_logger)
-[](https://travis-ci.org/k-ta-yamada/tee_logger)
-[](https://codeclimate.com/github/k-ta-yamada/tee_logger)
-[](https://codeclimate.com/github/k-ta-yamada/tee_logger/coverage)
-[](http://inch-ci.org/github/k-ta-yamada/tee_logger)
+[![Gem Version][gem_version-svg]][gem_version]
+[![Build Status][travis-svg]][travis]
+[![Code Climate][codeclimate-svg]][codeclimate]
+[![Test Coverage][codeclimate_cov-svg]][codeclimate_cov]
+[![Inline docs][inch-ci-svg]][inch-ci]
> Sorry. In from version 2 to version 3, changed usage.
-> see also [CHANGELOG.md](https://github.com/k-ta-yamada/tee_logger/blob/master/CHANGELOG.md).
+> see also [CHANGELOG.md][tee_logger-changelog].
- [Rubygems.org](https://rubygems.org/gems/tee_logger)
- [GitHub](https://github.com/k-ta-yamada/tee_logger)
- [RubyDoc.info](http://www.rubydoc.info/gems/tee_logger)
@@ -46,104 +46,105 @@
## Usage
```ruby
-require 'tee_logger'
+ require 'tee_logger'
-# Logger.new like options(logdev, shift_age, shift_size)
-# options default value is
-# logdev = './tee_logger.log'
-# shift_age = 0
-# shift_size = 1_048_576
-tl = TeeLogger.new
+ # Logger.new like options(logdev, shift_age, shift_size)
+ # options default value is
+ # logdev = './tee_logger.log'
+ # shift_age = 0
+ # shift_size = 1_048_576
+ tl = TeeLogger.new
-# let's logging
-tl.debug 'hello'
-tl.debug(:progname) { 'hello world' }
-tl.progname = 'App'
-tl.debug 'hello tee_logger'
+ # let's logging
+ tl.debug 'hello'
+ tl.debug(:progname) { 'hello world' }
+ tl.progname = 'App'
+ tl.debug 'hello tee_logger'
-# enable only when specified
-tl.info 'this message is console and logfile'
-tl.info 'this message is console only', :console
-tl.info 'this message is logfile only', :logfile
+ # enable only when specified
+ tl.info 'this message is console and logfile'
+ tl.info 'this message is console only', :console
+ tl.info 'this message is logfile only', :logfile
-# log meassage indent
-tl.info 'hello' # => 'hello'
-tl.info 'hello', 0 # => 'hello'
-tl.info 'hello', 2 # => ' hello'
+ # log meassage indent
+ tl.info 'hello' # => 'hello'
+ tl.info 'hello', 0 # => 'hello'
+ tl.info 'hello', 2 # => ' hello'
-# enabling and indent
-tl.info 'this message is console only', 2, :console
-tl.info 'this message is console only', :console, 2
+ # enabling and indent
+ tl.info 'this message is console only', 2, :console
+ tl.info 'this message is console only', :console, 2
-# disable console output
-tl.disable(:console)
-tl.info 'this message is logfile only'
+ # disable console output
+ tl.disable(:console)
+ tl.info 'this message is logfile only'
-# enable console output
-tl.enable(:console)
-tl.info 'this message is logfile and console'
+ # enable console output
+ tl.enable(:console)
+ tl.info 'this message is logfile and console'
-# disable logfile output
-tl.disable(:logfile)
-tl.info 'this message is consle only'
+ # disable logfile output
+ tl.disable(:logfile)
+ tl.info 'this message is consle only'
-# enable logfile output
-tl.enable(:logfile)
-tl.info 'this message is logfile and console'
+ # enable logfile output
+ tl.enable(:logfile)
+ tl.info 'this message is logfile and console'
-# disabe in block
-tl.disable(:console) do
- tl.info 'this message is logfile only'
-end
-tl.info 'this message is logfile and console'
+ # disabe in block
+ tl.disable(:console) do
+ tl.info 'this message is logfile only'
+ end
+ tl.info 'this message is logfile and console'
-# and others like Logger's
-tl.debug? # => true
-tl.info? # => true
-tl.warn? # => true
-tl.error? # => true
-tl.fatal? # => true
+ # and others like Logger's
+ tl.debug? # => true
+ tl.info? # => true
+ tl.warn? # => true
+ tl.error? # => true
+ tl.fatal? # => true
-tl.level # => 0
-tl.level = Logger::INFO
-tl.debug 'this message is not logging'
+ tl.level # => 0
+ tl.level = Logger::INFO
+ tl.debug 'this message is not logging'
-tl.formatter # => nil or Proc
-tl.formatter = proc { |severity, datetime, progname, message| "#{severity}:#{message}" }
+ tl.formatter # => nil or Proc
+ tl.formatter =
+ proc { |severity, datetime, progname, message| "#{severity}:#{message}" }
-tl.datetime_format # => nil or Proc
-tl.datetime_format = '%Y%m%d %H%M%S '
+ tl.datetime_format # => nil or Proc
+ tl.datetime_format = '%Y%m%d %H%M%S '
```
## include or extend TeeLogger for casual use
> TODO: the log file will be in default of `./tee_logger.log`
```ruby
-require 'tee_logger'
+ require 'tee_logger'
-class YourAwesomeClass
- include TeeLogger
+ class YourAwesomeClass
+ include TeeLogger
- def awesome_method
- # do somthing
- logger.info 'this is message is logging and disp console'
+ def awesome_method
+ # do somthing
+ logger.info 'this is message is logging and disp console'
+ end
end
-end
-module YourAwesomeModule
- extend TeeLogger
+ module YourAwesomeModule
+ extend TeeLogger
- def self.awesome_method
- # do somthing
- logger.info 'this is message is logging and disp console'
+ def self.awesome_method
+ # do somthing
+ logger.info 'this is message is logging and disp console'
+ end
end
-end
```
## Development
@@ -160,14 +161,35 @@
and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/k-ta-yamada/tee_logger.
+Bug reports and pull requests are welcome on GitHub
+at https://github.com/k-ta-yamada/tee_logger.
This project is intended to be a safe,
welcoming space for collaboration,
-and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+and contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
+
+
+[gem_version]: http://badge.fury.io/rb/tee_logger
+[gem_version-svg]: https://badge.fury.io/rb/tee_logger.svg
+
+[travis]: https://travis-ci.org/k-ta-yamada/tee_logger
+[travis-svg]: https://travis-ci.org/k-ta-yamada/tee_logger.svg
+
+[codeclimate]: https://codeclimate.com/github/k-ta-yamada/tee_logger
+[codeclimate-svg]: https://codeclimate.com/github/k-ta-yamada/tee_logger/badges/gpa.svg
+
+[codeclimate_cov]: https://codeclimate.com/github/k-ta-yamada/tee_logger/coverage
+[codeclimate_cov-svg]: https://codeclimate.com/github/k-ta-yamada/tee_logger/badges/coverage.svg
+
+[inch-ci]: http://inch-ci.org/github/k-ta-yamada/tee_logger
+[inch-ci-svg]: http://inch-ci.org/github/k-ta-yamada/tee_logger.svg?branch=master
+
+[tee_logger-changelog]: https://github.com/k-ta-yamada/tee_logger/blob/master/CHANGELOG.md