README.adoc in relaton-ieee-1.18.0 vs README.adoc in relaton-ieee-1.19.0
- old
+ new
@@ -21,28 +21,17 @@
$ gem install relaton-ieee
== Usage
-=== Configuration
+=== Search for a standard using keywords
-Configuration is optional. The available option is `logger` which is a `Logger` instance. By default, the logger is `Logger.new($stderr)` with `Logger::WARN` level. To change the logger level, use `RelatonIeee.configure` block.
-
[source,ruby]
----
require 'relaton_ieee'
=> true
-RelatonIeee.configure do |config|
- config.logger.level = Logger::DEBUG
-end
-----
-
-=== Search for a standard using keywords
-
-[source,ruby]
-----
item = RelatonIeee::IeeeBibliography.search("IEEE 528-2019")
=> #<RelatonIeee::IeeeBibliographicItem:0x00007fe12ebc8cb8
...
----
@@ -136,9 +125,13 @@
Started at: 2021-09-24 17:55:07 +0200
Stopped at: 2021-09-24 17:57:30 +0200
Done in: 143 sec.
=> nil
----
+
+=== Logging
+
+RelatonIeee uses the relaton-logger gem for logging. By default, it logs to STDOUT. To change the log levels and add other loggers, read the https://github.com/relaton/relaton-logger#usage[relaton-logger] documentation.
== Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.