README.md in ruby_universign-0.2.0 vs README.md in ruby_universign-1.0.0
- old
+ new
@@ -14,14 +14,25 @@
```ruby
gem 'ruby_universign', require: 'universign'
```
-And then run `bundle`
+And then `bundle`
-Or, #TODO
+Or install it with:
+```
+gem install ruby_universign
+```
+
+And load it with:
+
+```ruby
+require 'universign'
+```
+
+
## Usage
Configuration:
```ruby
@@ -64,14 +75,14 @@
# => "https://sign.test.universign.eu/fr/signature/?id=f052e35e-a792-4440-bb67-6b5c3f17aa30"
transaction.transaction_id
# => "9696179e-a43d-4803-beeb-9e5c02fd159b"
-# get back universign transaction:
+# reload transaction data from universign:
transaction = Universign::Transaction.new('9696179e-a43d-4803-beeb-9e5c02fd159b')
+# was the transaction signed by the user ?
transaction.signed?
-
```
### `Universign::Document`
It can be created with either your file's content or your file's url.
@@ -130,20 +141,14 @@
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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`.
-(# TODO) 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).
+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/CapSens/universign. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
-
-
-## notes
-
-final_doc_sent: pour que le document soit envoyé par mail au signataire