README.md in rdf-open_annotation-0.0.1 vs README.md in rdf-open_annotation-0.0.2
- old
+ new
@@ -1,27 +1,33 @@
# OpenAnnotation
-TODO: Write a gem description
+Contains vocabularies to be used by RDF ruby gem https://github.com/ruby-rdf/rdf/ to simplify coding when using OpenAnnotation data.
## Installation
Add this line to your application's Gemfile:
```ruby
-gem 'open_annotation'
+gem 'rdf-open_annotation'
```
And then execute:
$ bundle
Or install it yourself as:
- $ gem install open_annotation
+ $ gem install rdf-open_annotation
## Usage
-TODO: Write usage instructions here
+# @example Using these RDF vocabularies
+# include RDF
+# include rdf-open_annotation
+#
+# RDF::OpenAnnotation.Annotation #=> RDF::URI("http://www.w3.org/ns/oa#Annotation")
+# RDF::OpenAnnotation.hasBody #=> RDF::URI("http://www.w3.org/ns/oa#hasBody")
+# RDF::Content.chars #=> RDF::URI("http://www.w3.org/2011/content#chars")
## Contributing
1. Fork it ( https://github.com/[my-github-username]/open_annotation/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)