Some final formatting amends

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+- Added Multi Mode Support which allows for multi-segment encoding. Thanks to @ssayer
+
 ## [1.1.0] - 2021-07-01
 
 - Add a basic benchmark file

README.md

@@ -78,15 +78,17 @@ The library expects a string or array (for multiple encodings) to be parsed in,
 ```
 data - the string or array you wish to encode
 
-size   - the size (integer) of the qrcode (defaults to smallest size needed to encode the string)
+size - the size (integer) of the QR Code (defaults to smallest size needed to encode the string)
+
+max_size - the max_size (Integer) of the QR Code (default RQRCodeCore::QRUtil.max_size)
 
 level  - the error correction level, can be:
   * Level :l 7%  of code can be restored
   * Level :m 15% of code can be restored
   * Level :q 25% of code can be restored
   * Level :h 30% of code can be restored (default :h)
 
-mode   - the mode of the qrcode (defaults to alphanumeric or byte_8bit, depending on the input data):
+mode - the mode of the QR Code (defaults to alphanumeric or byte_8bit, depending on the input data, only used when data is a string):
   * :number
   * :alphanumeric
   * :byte_8bit

lib/rqrcode_core/qrcode.rb

@@ -3,11 +3,11 @@
 require "rqrcode_core/qrcode/qr_8bit_byte"
 require "rqrcode_core/qrcode/qr_alphanumeric"
 require "rqrcode_core/qrcode/qr_bit_buffer"
-require "rqrcode_core/qrcode/qr_segment"
 require "rqrcode_core/qrcode/qr_code"
 require "rqrcode_core/qrcode/qr_math"
+require "rqrcode_core/qrcode/qr_multi"
 require "rqrcode_core/qrcode/qr_numeric"
 require "rqrcode_core/qrcode/qr_polynomial"
 require "rqrcode_core/qrcode/qr_rs_block"
+require "rqrcode_core/qrcode/qr_segment"
 require "rqrcode_core/qrcode/qr_util"
-require "rqrcode_core/qrcode/qr_multi"

lib/rqrcode_core/qrcode/qr_code.rb

@@ -86,13 +86,14 @@ class QRCode
     # Expects a string or array (for multi-segment encoding) to be parsed in, other args are optional
     #
     #   # data - the string, QRSegment or array of Hashes (with data:, mode: keys) you wish to encode
-    #   # size   - the size (Integer) of the qrcode (defaults to smallest size needed to encode the data)
-    #   # level  - the error correction level, can be:
+    #   # size - the size (Integer) of the QR Code (defaults to smallest size needed to encode the data)
+    #   # max_size - the max_size (Integer) of the QR Code (default RQRCodeCore::QRUtil.max_size)
+    #   # level - the error correction level, can be:
     #      * Level :l 7%  of code can be restored
     #      * Level :m 15% of code can be restored
     #      * Level :q 25% of code can be restored
     #      * Level :h 30% of code can be restored (default :h)
-    #   # mode   - the mode of the qrcode (defaults to alphanumeric or byte_8bit, depending on the input data, only used when data is a string):
+    #   # mode - the mode of the QR Code (defaults to alphanumeric or byte_8bit, depending on the input data, only used when data is a string):
     #      * :number
     #      * :alphanumeric
     #      * :byte_8bit