Updates deps, improves docs, bumps version

Author: fireproofsocks

README.md

@@ -1,10 +1,18 @@
 # Xray
 
-Xray is an academic exploration of strings and encodings in [Elixir](https://elixir-lang.org/). 
+[![Module Version](https://img.shields.io/hexpm/v/xray.svg)](https://hex.pm/packages/xray)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/xray/)
+[![Total Download](https://img.shields.io/hexpm/dt/xray.svg)](https://hex.pm/packages/xray)
+[![License](https://img.shields.io/hexpm/l/xray.svg)](https://hex.pm/packages/xray)
+[![Last Updated](https://img.shields.io/github/last-commit/fireproofsocks/xray.svg)](https://github.com/fireproofsocks/xray/commits/master)
 
-It offers utility functions useful for inspecting strings and their code points. 
+Xray is an academic exploration of strings and encodings in [Elixir](https://elixir-lang.org/).
 
-For example, the `Xray.inspect/1` function:
+It offers utility functions useful for inspecting strings and their code points to better understand strings and encodings.
+
+## Examples
+
+The `Xray.inspect/1` function gives you a deep introspection on a string:
 
 ```elixir
 iex> Xray.inspect("cät")
@@ -16,21 +24,21 @@ iex> Xray.inspect("cät")
     Is printable? true
     ======================================================
 
-    c   Codepoint: 99 (\\u0063) https://codepoints.net/U+0063
+    c   Codepoint: 99 (\u0063) https://codepoints.net/U+0063
       Is printable? true
       Script(s): latin
       Byte Count: 1
       UTF-8: <<99>>
       Base2: 01100011
 
-    ä   Codepoint: 228 (\\u00E4) https://codepoints.net/U+00E4
+    ä   Codepoint: 228 (\u00E4) https://codepoints.net/U+00E4
       Is printable? true
       Script(s): latin
       Byte Count: 2
       UTF-8: <<195, 164>>
       Base2: 11000011 10100100
 
-    t   Codepoint: 116 (\\u0074) https://codepoints.net/U+0074
+    t   Codepoint: 116 (\u0074) https://codepoints.net/U+0074
       Is printable? true
       Script(s): latin
       Byte Count: 1
@@ -39,6 +47,22 @@ iex> Xray.inspect("cät")
     [:ok, :ok, :ok]
 ```
 
+The `Xray.codepoint/2` function provides the code point for a single character -- functionally, this is equivalent to what the question-mark operator `?` does, but `Xray.codepoint/2` allows you to inspect a variable (whereas `?` only operates on literal values):
+
+```elixir
+iex> Xray.codepoint("ä")
+228
+```
+
+`Xray.codepoints/2` allows you to inspect the component codepoint numbers that make up the given string:
+
+```elixir
+iex> Xray.codepoints("cät")
+      "99, 228, 116"
+```
+
+See [Xray Hex Docs](https://hexdocs.pm/xray/Xray.html) for more info.
+
 ## Installation
 
 If [available in Hex](https://hex.pm/docs/publish), the package can be installed
@@ -47,7 +71,7 @@ by adding `xray` to your list of dependencies in `mix.exs`:
 ```elixir
 def deps do
   [
-    {:xray, "~> 0.1.0"}
+    {:xray, "~> 1.2.0"}
   ]
 end
 ```
@@ -70,5 +94,6 @@ iex> "🇺🇸" <><<0>>
 ## See Also
 
 Some interesting articles
-- https://angelika.me/2017/07/11/print-my-string-elixir/
-- https://elixirforum.com/t/where-did-the-name-binaries-come-from-and-how-does-this-relate-to-base2/29490/14
+
+- <https://angelika.me/2017/07/11/print-my-string-elixir/>
+- <https://elixirforum.com/t/where-did-the-name-binaries-come-from-and-how-does-this-relate-to-base2/29490/14>

lib/xray.ex

@@ -131,27 +131,38 @@ defmodule Xray do
   Given a string binary, this returns a list of the codepoints that represent
   each of the characters in the string. This is what you might expect
   `String.codepoints/1` to return, but instead of returning a list of the
-  component *characters* like `String.codepoints/1` does, this function
-  returns the *numbers* (which is what code points are).
+  component *characters*, this function returns the *numbers* (which is what
+  code points are).
+
+  Note that this function returns a *string*: if a list is returned, Elixir will
+  usually attempt to format it as a human-readable string, which defeats the
+  purpose of the inspection.
+
+  This function offers output similar to what `IO.inspect/2` when the `:as_lists`
+  option set to `true`
 
-  Note that this function returns a string: if a list is returned, it will be
-  automatically displayed as a
   ## Options
-    - `:as_hex` (see `codepoint/2`)
+
+  - `:as_hex` (see `codepoint/2`)
 
   ## Examples
+
       iex> Xray.codepoints("cät")
       "99, 228, 116"
+
+  Compare this to inspecting a single-quoted charlist:
+
+      iex> IO.inspect('cät', charlists: :as_lists)
+      [99, 228, 116]
+
+  But `IO.inspect` will send output to STDOUT.
   """
   @spec codepoints(string :: binary, opts :: keyword) :: list
   def codepoints(string, opts \\ []) when is_binary(string) do
     string
     |> String.codepoints()
     |> Enum.map(fn x -> codepoint(x, opts) end)
     |> Enum.join(", ")
-
-    # We want to see the numbers!!!
-    #    IO.inspect(x, charlists: :as_lists)
   end
 
   # Converts a character like ä to its hexidecimal representation like `00E4`

mix.exs

@@ -1,7 +1,7 @@
 defmodule Xray.MixProject do
   use Mix.Project
 
-  @version "1.1.1"
+  @version "1.2.0"
 
   def project do
     [
@@ -14,8 +14,10 @@ defmodule Xray.MixProject do
       deps: deps(),
       package: package(),
       docs: [
+        main: "readme",
         source_ref: "v#{@version}",
-        logo: "logo.png"
+        logo: "logo.png",
+        extras: ["README.md"]
       ]
     ]
   end
@@ -28,7 +30,7 @@ defmodule Xray.MixProject do
   defp package do
     [
       maintainers: ["Everett Griffiths"],
-      licenses: ["Apache 2.0"],
+      licenses: ["Apache-2.0"],
       logo: "logo.png",
       links: links(),
       files: [
@@ -54,8 +56,8 @@ defmodule Xray.MixProject do
   defp deps do
     [
       {:base2, "~> 0.1.0"},
-      {:ex_unicode, "~> 1.11.0"},
-      {:ex_doc, "~> 0.23.0", runtime: false}
+      {:ex_unicode, "~> 1.12.0"},
+      {:ex_doc, "~> 0.28.3", runtime: false}
     ]
   end
 end

mix.lock

@@ -1,10 +1,11 @@
 %{
   "base2": {:hex, :base2, "0.1.0", "bc9e19f1578e1439010d26b1bee456f3ac980481a46c3643b24e15c40e1db0ed", [:mix], [], "hexpm", "a25eb2892e03f609fd5634aaf9a7795fb90f98dc9a7a495ed8c03b2844bbb647"},
   "earmark": {:hex, :earmark, "1.4.3", "364ca2e9710f6bff494117dbbd53880d84bebb692dafc3a78eb50aa3183f2bfd", [:mix], [], "hexpm", "8cf8a291ebf1c7b9539e3cddb19e9cef066c2441b1640f13c34c1d3cfc825fec"},
-  "earmark_parser": {:hex, :earmark_parser, "1.4.12", "b245e875ec0a311a342320da0551da407d9d2b65d98f7a9597ae078615af3449", [:mix], [], "hexpm", "711e2cc4d64abb7d566d43f54b78f7dc129308a63bc103fbd88550d2174b3160"},
-  "ex_doc": {:hex, :ex_doc, "0.23.0", "a069bc9b0bf8efe323ecde8c0d62afc13d308b1fa3d228b65bca5cf8703a529d", [:mix], [{:earmark_parser, "~> 1.4.0", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}], "hexpm", "f5e2c4702468b2fd11b10d39416ddadd2fcdd173ba2a0285ebd92c39827a5a16"},
-  "ex_unicode": {:hex, :ex_unicode, "1.11.0", "fb7dc40fe909e7e79163dbb3736e4d0e29e8ed5f0ff9d82ab1e95d1f287f7235", [:mix], [{:ex_doc, "~> 0.19", [hex: :ex_doc, repo: "hexpm", optional: false]}], "hexpm", "c2c8dd491a5aa18f9d30e5e765649f54d7c8f224496105f4a67ec73c80e1663c"},
-  "makeup": {:hex, :makeup, "1.0.5", "d5a830bc42c9800ce07dd97fa94669dfb93d3bf5fcf6ea7a0c67b2e0e4a7f26c", [:mix], [{:nimble_parsec, "~> 0.5 or ~> 1.0", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "cfa158c02d3f5c0c665d0af11512fed3fba0144cf1aadee0f2ce17747fba2ca9"},
-  "makeup_elixir": {:hex, :makeup_elixir, "0.15.0", "98312c9f0d3730fde4049985a1105da5155bfe5c11e47bdc7406d88e01e4219b", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.1", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "75ffa34ab1056b7e24844c90bfc62aaf6f3a37a15faa76b07bc5eba27e4a8b4a"},
-  "nimble_parsec": {:hex, :nimble_parsec, "1.1.0", "3a6fca1550363552e54c216debb6a9e95bd8d32348938e13de5eda962c0d7f89", [:mix], [], "hexpm", "08eb32d66b706e913ff748f11694b17981c0b04a33ef470e33e11b3d3ac8f54b"},
+  "earmark_parser": {:hex, :earmark_parser, "1.4.25", "2024618731c55ebfcc5439d756852ec4e85978a39d0d58593763924d9a15916f", [:mix], [], "hexpm", "56749c5e1c59447f7b7a23ddb235e4b3defe276afc220a6227237f3efe83f51e"},
+  "ex_doc": {:hex, :ex_doc, "0.28.3", "6eea2f69995f5fba94cd6dd398df369fe4e777a47cd887714a0976930615c9e6", [:mix], [{:earmark_parser, "~> 1.4.19", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1", [hex: :makeup_erlang, repo: "hexpm", optional: false]}], "hexpm", "05387a6a2655b5f9820f3f627450ed20b4325c25977b2ee69bed90af6688e718"},
+  "ex_unicode": {:hex, :ex_unicode, "1.12.0", "986b1310360617d7d9ac5dc8ec2f1504abc9857bc39512690444b328b7172856", [:mix], [], "hexpm", "6bc1cbc70320159eea53812eba3824c7089882cc77636b6de286b301b64ed267"},
+  "makeup": {:hex, :makeup, "1.1.0", "6b67c8bc2882a6b6a445859952a602afc1a41c2e08379ca057c0f525366fc3ca", [:mix], [{:nimble_parsec, "~> 1.2.2 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "0a45ed501f4a8897f580eabf99a2e5234ea3e75a4373c8a52824f6e873be57a6"},
+  "makeup_elixir": {:hex, :makeup_elixir, "0.16.0", "f8c570a0d33f8039513fbccaf7108c5d750f47d8defd44088371191b76492b0b", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "28b2cbdc13960a46ae9a8858c4bebdec3c9a6d7b4b9e7f4ed1502f8159f338e7"},
+  "makeup_erlang": {:hex, :makeup_erlang, "0.1.1", "3fcb7f09eb9d98dc4d208f49cc955a34218fc41ff6b84df7c75b3e6e533cc65f", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "174d0809e98a4ef0b3309256cbf97101c6ec01c4ab0b23e926a9e17df2077cbb"},
+  "nimble_parsec": {:hex, :nimble_parsec, "1.2.3", "244836e6e3f1200c7f30cb56733fd808744eca61fd182f731eac4af635cc6d0b", [:mix], [], "hexpm", "c8d789e39b9131acf7b99291e93dae60ab48ef14a7ee9d58c6964f59efb570b0"},
 }