README.md in hyperclient-0.7.2 vs README.md in hyperclient-0.8.0
- old
+ new
@@ -125,13 +125,14 @@
The client is responsible for supplying all the necessary parameters. Templated links don't do any strict parameter name checking and don't support required vs. optional parameters. Parameters not declared by the API will be dropped and will not have any effect when passed to `_expand`.
### Curies
-Curies are named tokens that you can define in the document and use to express curie relation URIs in a friendlier, more compact fashion. For example, the demo API contains very long links to images that use an "images" curie. Hyperclient handles curies and resolves these into full links automatically.
+Curies are a suggested means by which to link documentation of a given resource. For example, the demo API contains very long links to images that use an "images" curie.
```ruby
puts spline['image:thumbnail'] # => https://grape-with-roar.herokuapp.com/api/splines/uuid/images/thumbnail.jpg
+puts spline.links._curies['image'].expand('thumbnail') # => /docs/images/thumbnail
```
### Attributes
Resource attributes can also be accessed as a hash.