README.md in ezid-client-0.5.0 vs README.md in ezid-client-0.6.0
- old
+ new
@@ -1,6 +1,6 @@
-# Ezid::Client
+# EZID Client
EZID API Version 2 bindings. See http://ezid.cdlib.org/doc/apidoc.html.
[](http://badge.fury.io/rb/ezid-client)
[](https://travis-ci.org/duke-libraries/ezid-client)
@@ -69,10 +69,10 @@
=> #<Ezid::Identifier id="ark:/99999/fk4n58pc0r" DELETED>
```
## Metadata handling
-See `Ezid::Metadata` class and examples in `spec/unit/metadata_spec.rb`.
+Although "EZID imposes no requirements on the presence or form of citation metadata"[*](http://ezid.cdlib.org/doc/apidoc.html#metadata-requirements-mapping), `ezid-client` is intended to support the EZID [reserved metadata elements](http://ezid.cdlib.org/doc/apidoc.html#internal-metadata) and [metadata profiles](http://ezid.cdlib.org/doc/apidoc.html#metadata-profiles). While it is possible to use the client to send and receive any metadata, the object methods are geared towards the defined elements. Therefore it was seen fit, for example, to map the method `Ezid::Identifier#status` to the "_status" element. Likewise, all the reserved elements, except for "_crossref", have readers and -- for user-writable elements -- writers without the leading underscores. Since there are both "_crossref" and "crossref" elements, their accessors match the elements names. Similarly, accessors for metadata profile elements use underscores in place of dots -- for example, `Ezid::Identifer#dc_title` and `#dc_title=` for the "dc.title" element.
## Authentication
Credentials can be provided in any -- or a combination -- of these ways: