hexhelper 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09ced30dd9c164580fc5ae58cdb57017754b6163
-  data.tar.gz: 684781351e0bd8bcf0b3f5b8e316226600b431d6
+  metadata.gz: 3b6cea0da58d9efcbb5f7b35d67cb831aa8f156c
+  data.tar.gz: af3b60fbdf23bbfe5eb414da69586332726fe95b
 SHA512:
-  metadata.gz: 9dc22a33d841058aceb7affed3d243da28c0b2d9d0185c17c0a51147e83a7077c374adf526ac1478d9e87b62d26eb51602ad31c19493ab725877e6ce3eb33743
-  data.tar.gz: d4b4882c9a1a78c0cdaf6731ab11c3bf8334663a07205bd95ea353a72f3f4cb05bdf86dccc83c32a379afc40f0c3f51a8a5ea29aff0584e5fb4c1ac59b4ed55c
+  metadata.gz: 763e375faa501e97c887c7401bfd2bd3bb77e9c62a0de657db11ed28adb0fb6a68141bc6582704756c69a53dc2ec11bd124558b44108d8876041de19c1d7f8f4
+  data.tar.gz: aa5127f54de196c13e6ae3ce580135a6fbec7a7cfeecb7b2bcfd0bc59ded687f190def4d1f66536b05892653d2aa0220ec64d2eadd3137004bd832e80fe7e63a

data/README.md

@@ -29,7 +29,28 @@ Using it is simple!
 require 'hexhelper'
 
 str = "This is a test string\x00\x01\x02"
-puts Hexhelper::to_s(str)
+puts HexHelper::to_s(str)
+```
+
+Which generates:
+
+```
+irb(main):001:0> require 'hexhelper'
+=> true
+irb(main):002:0> str = "This is a test string \x00\x01\x02"
+=> "This is a test string \u0000\u0001\u0002"
+irb(main):003:0> puts HexHelper::to_s(str)
+00000000  54 68 69 73 20 69 73 20 61 20 74 65 73 74 20 73   This.is.a.test.s
+00000010  74 72 69 6e 67 20 00 01 02                        tring....
+```
+
+It's also possible to indent with the `indent` parameter, and to highlight a
+particular offset with the `offset` parameter:
+
+```
+irb(main):004:0> puts HexHelper::to_s(str, indent: 4, offset: 0x10)
+    00000000  54 68 69 73 20 69 73 20 61 20 74 65 73 74 20 73   This.is.a.test.s
+    00000010 <74>72 69 6e 67 20 00 01 02                        tring....
 ```
 
 ## Contributing

data/lib/hexhelper/version.rb

@@ -1,3 +1,3 @@
 module Hexhelper
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hexhelper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - iagox86