README.adoc in relaton-cie-1.9.1 vs README.adoc in relaton-cie-1.10.0
- old
+ new
@@ -111,17 +111,45 @@
<ext>
<doctype>document</doctype>
</ext>
</bibdata>"
----
+ === Typed links
+Each CIE document has `src` type link.
+
+[source,ruby]
+----
+item.link
+=> [#<RelatonBib::TypedUri:0x00007fe58e8d4048 @content=#<Addressable::URI:0xbe50 URI:https://www.techstreet.com/cie/standards/cie-001-1980?product_id=1210107>, @type="src">]
+----
+
=== Parse a file locally
[source,ruby]
----
item = RelatonBib::XMLParser.from_xml File.read("spec/fixtures/bibdata.xml")
=> #<RelatonBib::BibliographicItem:0x007fb4061aa498
...
+----
+
+=== Fetch data
+
+This gem uses the https://www.techstreet.com/cie/searches/31156444 dataset as one of data sources.
+
+The method `RelatonCie::DataFetcher.fetch(output: "data", format: "yaml")` fetches all the documents from the datast and save them to the `./data` folder in YAML format.
+Arguments:
+
+- `output` - folder to save documents (default './data').
+- `format` - format in which the documents are saved. Possimle formats are: `yaml`, `xml` (default `yaml`).
+
+[source,ruby]
+----
+RelatonCie::DataFetcher.fetch
+Started at: 2021-09-08 16:37:53 +0200
+Stopped at: 2021-09-08 16:49:17 +0200
+Done in: 684 sec.
+=> nil
----
== 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.