README.adoc in relaton-iana-1.18.0 vs README.adoc in relaton-iana-1.19.0

- old
+ new

@@ -21,28 +21,17 @@ $ gem install relaton-iana == 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 `RelatonIana.configure` block. - [source,ruby] ---- require 'relaton_iana' => true -RelatonIana.configure do |config| - config.logger.level = Logger::DEBUG -end ----- - -=== Search for a standard using keywords - -[source,ruby] ----- item = RelatonIana::IanaBibliography.get "IANA service-names-port-numbers" [relaton-iana] (IANA service-names-port-numbers) Fetching from Relaton repository ... [relaton-iana] (IANA service-names-port-numbers) Found: `IANA service-names-port-numbers` => #<RelatonIana::IanaBibliographicItem:0x00007f7c6cc024d0 ... @@ -121,9 +110,13 @@ ---- This method uses GitHub search API to fetch the documents. The search API has a https://docs.github.com/en/rest/reference/search#rate-limit[rate limitaion] of 30 requests per minute for authenticated users and 10 requests per minute for unauthenticated users. Usually, the rate limit is not reached because the search API is used only for the file list fetching. But if you run the method multiple times in a short period, the rate limit may be reached. In this case, the method will wait until the rate limit is reset. You can use a personal access token (PTA) to increase the rate limit. To do this, add your PTA to the `GITHUB_TOKEN` environment variable. + +=== Logging + +RelatonIana 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.