summaryrefslogtreecommitdiff
path: root/vendor/bundle/ruby/3.4.0/gems/logger-1.7.0/README.md
diff options
context:
space:
mode:
authorBen Sanders <ben@sanders.life>2026-08-02 09:49:25 -0400
committerBen Sanders <ben@sanders.life>2026-08-02 09:49:25 -0400
commitb41479c91e6685511c1f8ba8586106b322073b62 (patch)
treec9f1345999d754ae0a533849966427e792d9e68d /vendor/bundle/ruby/3.4.0/gems/logger-1.7.0/README.md
parentcfaceeb9a6d1295f5754be211858155cd309acc2 (diff)
added statscounter code
Diffstat (limited to 'vendor/bundle/ruby/3.4.0/gems/logger-1.7.0/README.md')
-rw-r--r--vendor/bundle/ruby/3.4.0/gems/logger-1.7.0/README.md104
1 files changed, 104 insertions, 0 deletions
diff --git a/vendor/bundle/ruby/3.4.0/gems/logger-1.7.0/README.md b/vendor/bundle/ruby/3.4.0/gems/logger-1.7.0/README.md
new file mode 100644
index 0000000..ceb1a21
--- /dev/null
+++ b/vendor/bundle/ruby/3.4.0/gems/logger-1.7.0/README.md
@@ -0,0 +1,104 @@
+# Logger
+
+Logger is a simple but powerful logging utility to output messages in your Ruby program.
+
+Logger has the following features:
+
+ * Print messages to different levels such as `info` and `error`
+ * Auto-rolling of log files
+ * Setting the format of log messages
+ * Specifying a program name in conjunction with the message
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logger'
+```
+
+And then execute:
+
+ $ bundle
+
+Or install it yourself as:
+
+ $ gem install logger
+
+## Usage
+
+### Simple Example
+
+```ruby
+require 'logger'
+
+# Create a Logger that prints to STDOUT
+log = Logger.new(STDOUT)
+log.debug("Created Logger")
+
+log.info("Program finished")
+
+# Create a Logger that prints to STDERR
+error_log = Logger.new(STDERR)
+error_log = error_log.error("fatal error")
+```
+
+## Development
+
+After checking out the repo, run the following to install dependencies.
+
+```
+$ bin/setup
+```
+
+Then, run the tests as:
+
+```
+$ rake test
+```
+
+To install this gem onto your local machine, run
+
+```
+$ rake install
+```
+
+To release a new version, update the version number in `lib/logger/version.rb`, and then run
+
+```
+$ rake release
+```
+
+which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Advanced Development
+
+### Run tests of a specific file
+
+```
+$ ruby test/logger/test_logger.rb
+```
+
+### Run tests filtering test methods by a name
+
+`--name` option is available as:
+
+```
+$ ruby test/logger/test_logger.rb --name test_lshift
+```
+
+### Publish documents to GitHub Pages
+
+```
+$ rake gh-pages
+```
+
+Then, git commit and push the generated HTMLs onto `gh-pages` branch.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/logger.
+
+## License
+
+The gem is available as open source under the terms of the [BSD-2-Clause](BSDL).