README.md in signed_xml-0.0.1 vs README.md in signed_xml-1.0.0
- old
+ new
@@ -1,27 +1,57 @@
-# SignedXmlDocument
+SignedXml [](https://travis-ci.org/toddthomas/signed_xml)
+=========
-TODO: Write a gem description
+SignedXml is a Ruby implementation of [XML Signatures](http://www.w3.org/TR/xmldsig-core).
-## Installation
+Dependencies
+------------
+SignedXml requires and is in love with [Nokogiri](http://nokogiri.org).
+
+Limitations
+-----------
+
+They are legion. Currently only verification of signed documents is supported.
+Allowed transformations are enveloped-signature and c14n. Only same-document
+Reference URIs are supported, and of those only the null URI (URI="", or
+the whole document) and fragment URIs which specify a literal ID are supported.
+XPointer expressions are not supported.
+
+Installation
+------------
+
Add this line to your application's Gemfile:
- gem 'signed_xml_document'
+```ruby
+gem 'signed_xml'
+```
And then execute:
- $ bundle
+```shell
+bundle
+```
Or install it yourself as:
- $ gem install signed_xml_document
+```shell
+gem install signed_xml
+```
-## Usage
+Usage
+-----
-TODO: Write usage instructions here
+```ruby
+require 'signed_xml'
-## Contributing
+doc = Nokogiri::XML(File.read 'some_signed_doc.xml')
+signed_doc = SignedXml::Document.new(doc)
+signed_doc.is_verified?
+```
+
+Contributing
+------------
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)