README.md in hexdump-1.0.0 vs README.md in hexdump-1.0.1
- old
+ new
@@ -1,16 +1,17 @@
# hexdump.rb
[](https://github.com/postmodern/hexdump.rb/actions/workflows/ruby.yml)
+[](https://badge.fury.io/rb/hexdump)
* [Source](https://github.com/postmodern/hexdump.rb)
* [Issues](https://github.com/postmodern/hexdump.rb/issues)
-* [Documentation](http://rubydoc.info/gems/hexdump/frames)
+* [Documentation](https://rubydoc.info/gems/hexdump)
## Description
-Simple and Fast hexdumping for Ruby.
+Fully Featured and Fast hexdumping for Ruby.
## Features
* Supports printing ASCII, hexadecimal, decimal, octal and binary bytes.
* Supports hexdumping bytes, characters, signed/unsigned integers,
@@ -25,28 +26,33 @@
* `int16_ne` / `short_ne` - signed 16bit integer (network endian)
* `uint16` / `ushort` - unsigned 16bit integer
* `uint16_le` / `ushort_le` - unsigned 16bit integer (little endian)
* `uint16_be` / `ushort_be` - unsigned 16bit integer (big endian)
* `uint16_ne` / `ushort_ne` - unsigned 16bit integer (network endian)
- * `int32` / `int` / `long` - signed 32bit integer
- * `int32_le` / `int_le` / `long_le` - signed 32bit integer (little endian)
- * `int32_be` / `int_be` / `long_be` - signed 32bit integer (big endian)
- * `int32_ne` / `int_ne` / `long_ne` - signed 32bit integer (network endian)
- * `uint32` / `uint` / `ulong` - unsigned 32bit integer
- * `uint32_le` / `uint_le` / `ulong_le` - unsigned 32bit integer
+ * `int32` / `int` - signed 32bit integer
+ * `int32_le` / `int_le` - signed 32bit integer (little endian)
+ * `int32_be` / `int_be` - signed 32bit integer (big endian)
+ * `int32_ne` / `int_ne` - signed 32bit integer (network endian)
+ * `uint32` / `uint` / - unsigned 32bit integer
+ * `uint32_le` / `uint_le` - unsigned 32bit integer
(little endian)
- * `uint32_be` / `uint_be` / `ulong_be` - unsigned 32bit integer (big endian)
- * `uint32_ne` / `uint_ne` / `ulong_ne` - unsigned 32bit integer
+ * `uint32_be` / `uint_be` - unsigned 32bit integer (big endian)
+ * `uint32_ne` / `uint_ne` - unsigned 32bit integer
(network endian)
- * `int64` / `long_long` - signed 64bit integer
- * `int64_le` / `long_long_le` - signed 64bit integer (little endian)
- * `int64_be` / `long_long_be` - signed 64bit integer (big endian)
- * `int64_ne` / `long_long_ne` - signed 64bit integer (network endian)
- * `uint64` / `ulong_long` - unsigned 64bit integer
- * `uint64_le` / `ulong_long_le` - unsigned 64bit integer (little endian)
- * `uint64_be` / `ulong_long_be` - unsigned 64bit integer (big endian)
- * `uint64_ne` / `ulong_long_ne` - unsigned 64bit integer (network endian)
+ * `int64` / `long` / `long_long` - signed 64bit integer
+ * `int64_le` / `long_le` / `long_long_le` - signed 64bit integer
+ (little endian)
+ * `int64_be` / `long_be` / `long_long_be` - signed 64bit integer (big endian)
+ * `int64_ne` / `long_ne` / `long_long_ne` - signed 64bit integer
+ (network endian)
+ * `uint64` `ulong` / `ulong_long` - unsigned 64bit integer
+ * `uint64_le` / `ulong_le` / `ulong_long_le` - unsigned 64bit integer
+ (little endian)
+ * `uint64_be` / `ulong_be` / `ulong_long_be` - unsigned 64bit integer
+ (big endian)
+ * `uint64_ne` / `ulong_ne` / `ulong_long_ne` - unsigned 64bit integer
+ (network endian)
* `float` - single precision 32bit floating-point number
* `float_le` - single precision 32bit floating-point number (little endian)
* `float_be` - single precision 32bit floating-point number (big endian)
* `float_ne` - single precision 32bit floating-point number (network endian)
* `double` - double precision 64bit floating-point number
@@ -64,10 +70,16 @@
* Can hexdump any Object supporting the `each_byte` method.
* Can send the hexdump output to any Object supporting the `<<` method.
* Makes {String}, {StringIO}, {IO}, {File} objects hexdumpable.
* Fast-ish.
+## Requirements
+
+* [Ruby] >= 2.0.0
+
+[Ruby]: https://www.ruby-lang.org/
+
## Install
```shell
$ gem install hexdump
```
@@ -239,10 +251,10 @@
```
### Int Type
```ruby
-Hexdump.hexdump([65535, -1].pack("LL"), type: :int32_be, base: 10)
+Hexdump.hexdump([65535, -1].pack("LL"), type: :int32, base: 10)
# 00000000 65535 -1 |........|
# 00000008
```
### Char Type