README.md in unibits-2.1.0 vs README.md in unibits-2.1.1
- old
+ new
@@ -2,12 +2,12 @@
Ruby library and CLI command that visualizes various Unicode and ASCII/single byte encodings in the terminal:
- Makes analyzing encodings easier
- Helps you with debugging strings
-- Supports **UTF-8**, **UTF-16LE**/**UTF-16BE**, **UTF-32LE**/**UTF-32BE**, **ISO-8859-X**, **Windows-125X**, **IBMX**, **CP85X**, **macX**, **TIS-620**/**Windows-874**, **KOI8-R**/**KOI8-U**, arbitrary **BINARY** data, and 7-Bit **ASCII**
- Highlights invalid/special/blank bytes/characters/codepoints
+- Supports *UTF-8*, *UTF-16LE*/*UTF-16BE*, *UTF-32LE*/*UTF-32BE*, *ISO-8859-X*, *Windows-125X*, *IBMX*, *CP85X*, *macX*, *TIS-620*/*Windows-874*, *KOI8-R*/*KOI8-U*, 7-Bit *ASCII*, and arbitrary *BINARY* data
## Color Coding
Each byte of the given string is highlighted using the following mechanism (characters -> codepoints):
@@ -51,11 +51,11 @@
- *convert (c)*: An encoding the string should be converted to before visualizing it
- *stats*: Whether to show a short stats header (default: `true`), you can deactivate on the CLI with `--no-stats`
- *wide-ambiguous*: Treat characters of ambiguous width as 2 spaces instead of 1 ([more info](https://github.com/janlelis/unicode-display_width))
- *width (w)*: Set a custom column width, if not set, *unibits* will retrieve it from the terminal or just use 80
-## Output of Different Valid Encodings
+## Examples of Valid Encodings
### UTF-8
CLI: `$ unibits -e utf-8 -c utf-8 "馃尗 Idio锘縮yncr盲tic 鈩溦结柉蕪"`
Ruby: `unibits "馃尗 Idio锘縮yncr盲tic 鈩溦结柉蕪", encoding: 'utf-8', convert: 'utf-8'`
@@ -68,26 +68,10 @@
Ruby: `unibits "馃尗 Idio锘縮yncr盲tic 鈩溦结柉蕪", encoding: 'utf-8', convert: 'utf-16le'`
![Screenshot UTF-16LE](/screenshots/utf-16le.png?raw=true "UTF-16LE")
-### UTF-16BE
-
-CLI: `$ unibits -e utf-8 -c utf-16be "馃尗 Idio锘縮yncr盲tic 鈩溦结柉蕪"`
-
-Ruby: `unibits "馃尗 Idio锘縮yncr盲tic 鈩溦结柉蕪", encoding: 'utf-8', convert: 'utf-16be'`
-
-![Screenshot UTF-16BE](/screenshots/utf-16be.png?raw=true "UTF-16BE")
-
-### UTF-32LE
-
-CLI: `$ unibits -e utf-8 -c utf-32le "馃尗 Idio锘縮yncr盲tic 鈩溦结柉蕪"`
-
-Ruby: `unibits "馃尗 Idio锘縮yncr盲tic 鈩溦结柉蕪", encoding: 'utf-8', convert: 'utf-32le'`
-
-![Screenshot UTF-32LE](/screenshots/utf-32le.png?raw=true "UTF-32LE")
-
### UTF-32BE
CLI: `$ unibits -e utf-8 -c utf-32be "馃尗 Idio锘縮yncr盲tic 鈩溦结柉蕪"`
Ruby: `unibits "馃尗 Idio锘縮yncr盲tic 鈩溦结柉蕪", encoding: 'utf-8', convert: 'utf-32be'`
@@ -104,15 +88,15 @@
### ASCII
CLI: `$ unibits -e utf-8 -c ascii "ascii"`
-Ruby: `unibits "ASCII String", encoding: 'utf-8', convert: 'ascii'`
+Ruby: `unibits "ascii", encoding: 'utf-8', convert: 'ascii'`
![Screenshot ASCII](/screenshots/ascii.png?raw=true "ASCII")
-## Invalid Encodings
+## Examples of Invalid Encodings
### UTF-8
Example in Ruby: `unibits "unexpected \x80 | not enough \xF0\x9F\x8C | overlong \xE0\x81\x81 | surrogate \xED\xA0\x80 | too large \xF5\x8F\xBF\xBF"`
![Screenshot invalid UTF-8](/screenshots/utf-8.invalid.png?raw=true "Invalid UTF-8")
@@ -120,13 +104,9 @@
### ASCII
Example in Ruby: `unibits "馃尗 Idio锘縮yncr盲tic 鈩溦结柉蕪", encoding: 'ascii'`
![Screenshot invalid ASCII](/screenshots/ascii.invalid.png?raw=true "Invalid ASCII")
-
-### BINARY
-
-Not possible to produce invalid binary strings
## Notes
Also see