LogScroll
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/log_scroll
. To experiment with that code, run bin/console
for an interactive prompt.
TODO: Delete this and the text above, and describe your gem
Installation
Add this line to your application's Gemfile:
gem 'log_scroll'
And then execute:
$ bundle
Or install it yourself as:
$ gem install log_scroll
Usage
Proposed API:
scroll = LogScroll.new(max_size: 10, file_name: "development.log")
scroll.log("first log entry")
scroll.log("second log entry")
scroll.entries
# => ["first log entry\n", "second log entry\n"]
puts "Oldest Entry: " + scroll.oldest_entry
# => "Oldest Entry: first log entry"
puts "Newest Entry: " + scroll.newest_entry
# => "Newest Entry: second log entry"
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
to create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
- Fork it ( https://github.com/[my-github-username]/log_scroll/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request