Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jshawl committed Feb 17, 2024
1 parent 7cad5dc commit c6aab17
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Minisign

A rubygem for creating and verifying [Minisign](http://jedisct1.github.io/minisign/) signatures.
A ruby implemenation of [Minisign](http://jedisct1.github.io/minisign/).

- [Installation \& Usage](#installation--usage)
- [Read a public key](#read-a-public-key)
Expand Down Expand Up @@ -57,7 +57,9 @@ private_key.change_password! nil
```rb
file_path = "example.txt"
password = "password"
signature = private_key.sign(file_path, File.read(file_path))
trusted_comment = "the trusted comment"
untrusted_comment = "the untrusted comment"
signature = private_key.sign(file_path, File.read(file_path), trusted_comment, untrusted_comment)
File.write("#{file_path}.minisig", signature.to_s)
```

Expand Down

0 comments on commit c6aab17

Please sign in to comment.