base64url 1.0.0 → 1.0.1

data/lib/base64url.rb

@@ -1,4 +1,26 @@
-# The Base64URL module provides for the encoding and decoding method using base64url representation.
+#
+# = base64url.rb: methods for base64url-encoding and -decoding strings
+#
+
+# The Base64URL module provides for the encoding and decoding of binary data
+# using a base64url representation.
+#
+# base64url encoding is Base64 for URLs and filenames.
+# base64url's 62nd and 63rd chars are '-' and '_'.
+# base64url does not have pad chars '='.
+#
+# == Example
+#
+# A simple encoding and decoding.
+#
+#     require "base64url"
+#
+#     enc   = Base64URL.encode('Send reinforcements')
+#                         # -> "U2VuZCByZWluZm9yY2VtZW50cw"
+#     plain = Base64URL.decode(enc)
+#                         # -> "Send reinforcements"
+#
+
 module Base64URL
   module_function
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: base64url
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors: