README.md in datacite-0.1.1 vs README.md in datacite-0.2.0
- old
+ new
@@ -20,12 +20,54 @@
$ gem install datacite
## Usage
+### Initialize the client
```ruby
-client = Datacite::Client.new(username: "foo", password: "bar")
-result = client.autogenerate_doi
+client = Datacite::Client.new(username: "foo",
+ password: "bar",
+ host: "api.test.datacite.org")
+```
+
+### Create a Draft DOI
+
+```ruby
+result = client.register_doi(prefix: '10.0001', suffix: 'bc123df4567')
+
+result.either(
+ -> response { response.doi },
+ -> response { raise("Something went wrong", response.status) }
+)
+```
+
+#### Auto-generated DOI's
+
+```ruby
+result = client.autogenerate_doi(prefix: '10.0001')
+
+result.either(
+ -> response { response.doi },
+ -> response { raise("Something went wrong", response.status) }
+)
+```
+
+### Update DOI's
+
+```ruby
+# See https://support.datacite.org/reference/dois-2#put_dois-id for the attributes
+attributes = {
+ relatedIdentifiers: [
+ {
+ relatedIdentifier: "https://doi.org/10.xxxx/xxxxx",
+ relatedIdentifierType: "DOI",
+ relationType: "References",
+ resourceTypeGeneral: "Dataset"
+ }
+ ]
+}
+result = client.update(id: '10.0001/bc123df4567', attributes: attributes)
+
result.either(
-> response { response.doi },
-> response { raise("Something went wrong", response.status) }
)
```