Skip to content

Commit

Permalink
Bump to version 3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
mdp committed Apr 18, 2016
1 parent 21c88f7 commit c73784e
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 3 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
### Changelog

#### 3.0.0

- Provisioning URL includes issuer label per RFC 5234 See mdp/rotp/pull/51

#### 2.1.2

- Remove string literals to prepare immutable strings in Ruby 3.0
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Optionally, you can provide an issuer which will be used as a title in Google Au

```ruby
totp = ROTP::TOTP.new("base32secret3232", issuer: "My Service")
totp.provisioning_uri("alice@google.com")
```

### Counter based OTP's
Expand Down Expand Up @@ -68,8 +69,8 @@ Provisioning URI's generated by ROTP are compatible with the Google Authenticato
to be scanned with the in-built QR Code scanner.

```ruby
totp.provisioning_uri("alice@google.com") # => 'otpauth://totp/alice@google.com?secret=JBSWY3DPEHPK3PXP'
hotp.provisioning_uri("alice@google.com", 0) # => 'otpauth://hotp/alice@google.com?secret=JBSWY3DPEHPK3PXP&counter=0'
totp.provisioning_uri("alice@google.com") # => 'otpauth://totp/issuer:alice@google.com?secret=JBSWY3DPEHPK3PXP'
hotp.provisioning_uri("alice@google.com", 0) # => 'otpauth://hotp/issuer:alice@google.com?secret=JBSWY3DPEHPK3PXP&counter=0'
```

This can then be rendered as a QR Code which can then be scanned and added to the users
Expand Down
2 changes: 1 addition & 1 deletion lib/rotp/version.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module ROTP
VERSION = "2.1.2"
VERSION = "3.0.0"
end

0 comments on commit c73784e

Please sign in to comment.