README.md in cose-0.1.0 vs README.md in cose-0.2.0
- old
+ new
@@ -1,10 +1,11 @@
-# Cose
+# cose
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cose`. To experiment with that code, run `bin/console` for an interactive prompt.
+COSE ([RFC 8152](https://tools.ietf.org/html/rfc8152)) in ruby
-TODO: Delete this and the text above, and describe your gem
+[](https://rubygems.org/gems/cose)
+[](https://travis-ci.org/cedarcode/cose-ruby)
## Installation
Add this line to your application's Gemfile:
@@ -20,20 +21,55 @@
$ gem install cose
## Usage
-TODO: Write usage instructions here
+### Key Objects
+#### EC2
+
+```ruby
+cbor_data = "..."
+
+key = COSE::Key::EC2.from_cbor(cbor_data)
+
+key.curve
+key.x_coordinate
+key.y_coordinate
+key.d_coordinate
+```
+
+#### Symmetric
+
+```ruby
+cbor_data = "..."
+
+key = COSE::Key::Symmetric.from_cbor(cbor_data)
+
+key.key_value
+```
+
+### Signing Objects
+
+_Pending_
+
+### MAC Objects
+
+_Pending_
+
+### Encryption Objects
+
+_Pending_
+
## 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.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cose.
+Bug reports and pull requests are welcome on GitHub at https://github.com/cedarcode/cose-ruby.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).