From 804f71845c18b08bb43d4d88393b724f43e31924 Mon Sep 17 00:00:00 2001
From: Amos L King <amos@binarynoggin.com>
Date: Sun, 27 Oct 2024 17:01:38 -0500
Subject: [PATCH] Adds support for hex, ex_doc, and Elixir

Elixir is a popular alternative on the BEAM, and by supporting those
users as part of the RAIK ecosystem, we can bring Riak to even more
projects.

To generate documents, run `rebar ex_doc`. This command builds
documentation and places it in a `doc` folder. Open `doc/index.html` to
view the generated documentation.

I have set up the framework so that we can publish this to hex and get
more exposure. The documentation should be pointed to hex instead of the
GitHub repo if we publish there.
---
 .gitignore                  |  1 +
 README.md                   | 22 +++++++++++++++++++++-
 rebar.config                | 10 +++++++++-
 src/ring_calculator.app.src |  4 +++-
 4 files changed, 34 insertions(+), 3 deletions(-)

diff --git a/.gitignore b/.gitignore
index df53f7d..9a52c70 100644
--- a/.gitignore
+++ b/.gitignore
@@ -18,3 +18,4 @@ logs
 *.iml
 rebar3.crashdump
 *~
+doc/
\ No newline at end of file
diff --git a/README.md b/README.md
index cbd9bf7..3f459c9 100644
--- a/README.md
+++ b/README.md
@@ -54,7 +54,7 @@ ok
 ```
 
 With 8 nodes and 4 locations at your proposal, you can get a target n-val of 8 and a location nval of 4.
-That means that you can configure the system in such a way that you can loose 3 locations or 3 nodes and
+That means that you can configure the system in such a way that you can lose 3 locations or 3 nodes and
 still have one copy of all data available. Moreover, you have enough additional nodes to act take over the role of the lost nodes.
 
 ## Rebar3 plugin
@@ -81,3 +81,23 @@ Usage: rebar3 ring_calculator [-s <ring_size>] [-n <nodes>]
   -v, --verbose    print computation details
 ```
 
+## Elixir
+
+```elixir
+iex> Mix.install([{:ring_calculator, [github: "OpenRiak/ring_calculator", branch: "main"]}])
+iex> :ring_calculator.nvals(32, 8, 3)
+........................................x
+Best solution:
+Target Nval 8
+Location val 2
+Config [4,4]
+Ring: A1 B1 A2 B2 A3 B3 A4 B4 A1 B1 A2 B2 A3 B3 A4 B4 A1 B1 A2 B2 A3 B3 A4 B4 A1 B1 A2 B2 A3 B3 A4 B4 (0 violations)
+:ok
+```
+
+If you would like to be able to use `ring_calculator` from a mix project you can add the following
+dependency to your `mix.exs` deps.
+
+```elixir
+{:ring_calculator, github: "OpenRiak/ring_calculator", runtime: false}
+```
\ No newline at end of file
diff --git a/rebar.config b/rebar.config
index f618f3e..8eed124 100644
--- a/rebar.config
+++ b/rebar.config
@@ -1,2 +1,10 @@
 {erl_opts, [debug_info]}.
-{deps, []}.
\ No newline at end of file
+{deps, []}.
+{plugins, [rebar3_hex, rebar3_ex_doc]}.
+{hex, [{doc, #{provider => ex_doc}}]}.
+{ex_doc, [
+    {source_url, <<"https://github.com/OpenRiak/ring_calculator">>},
+    {homepage_url, <<"https://github.com/OpenRiak/ring_calculator">>},
+    {extras, [<<"README.md">>, <<"LICENSE">>]},
+    {main, <<"README.md">>}
+]}.
\ No newline at end of file
diff --git a/src/ring_calculator.app.src b/src/ring_calculator.app.src
index 526cb9c..d300f09 100644
--- a/src/ring_calculator.app.src
+++ b/src/ring_calculator.app.src
@@ -9,5 +9,7 @@
     {env, []},
     {modules, []},
     {licenses, ["Apache-2.0"]},
-    {links, []}
+    {links, [
+        {"GitHub", "https://github.com/OpenRiak/ring_calculator"}
+    ]}
  ]}.