Skip to content

Commit

Permalink
Convert readme to markdown and add content
Browse files Browse the repository at this point in the history
Add license + badges
  • Loading branch information
tas50 committed Mar 2, 2016
1 parent dc89358 commit e3bc40e
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 25 deletions.
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Mixlib::Log

[![Build Status Master](https://travis-ci.org/chef/mixlib-log.svg?branch=master)](https://travis-ci.org/chef/mixlib-log) [![Gem Version](https://badge.fury.io/rb/mixlib-log.svg)](https://badge.fury.io/rb/mixlib-log)

Mixlib::Log provides a mixin for enabling a class based logger object, a-la Merb, Chef, and Nanite. To use it:

```ruby
require 'mixlib/log'

class Log
extend Mixlib::Log
end
```

You can then do:

```ruby
Log.debug('foo')
Log.info('bar')
Log.warn('baz')
Log.error('baz')
Log.fatal('wewt')
```

By default, `Mixlib::Logger` logs to STDOUT. To alter this, you should call +Log.init+, passing any arguments to the standard Ruby Logger. For example:

```ruby
Log.init('/tmp/logfile') # log to /tmp/logfile
Log.init('/tmp/logfile', 7) # log to /tmp/logfile, rotate every day
```

Enjoy!

## LICENSE:

- Copyright:: Copyright (c) 2008-2016 Chef Software, Inc.
- License:: Apache License, Version 2.0

```text
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
24 changes: 0 additions & 24 deletions README.rdoc

This file was deleted.

2 changes: 1 addition & 1 deletion mixlib-log.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Gem::Specification.new do |gem|
gem.license = "Apache-2.0"
gem.authors = ["Opscode, Inc."]
gem.has_rdoc = true
gem.extra_rdoc_files = ["README.rdoc", "LICENSE", 'NOTICE']
gem.extra_rdoc_files = ["README.md", "LICENSE", 'NOTICE']
gem.files = Dir['lib/**/*'] + Dir['spec/**/*'] + ["Gemfile", "Rakefile", ".gemtest", "mixlib-log.gemspec"]
gem.add_development_dependency 'rake'
gem.add_development_dependency 'rspec', '~> 2.10'
Expand Down

0 comments on commit e3bc40e

Please sign in to comment.