Added a prime generation library written in Elixir
[sandbox] / elixir_primes / README.md
diff --git a/elixir_primes/README.md b/elixir_primes/README.md
new file mode 100644 (file)
index 0000000..be7392f
--- /dev/null
@@ -0,0 +1,23 @@
+# Primes
+
+**TODO: Add description**
+
+## Installation
+
+If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:
+
+  1. Add `primes` to your list of dependencies in `mix.exs`:
+
+    ```elixir
+    def deps do
+      [{:primes, "~> 0.1.0"}]
+    end
+    ```
+
+  2. Ensure `primes` is started before your application:
+
+    ```elixir
+    def application do
+      [applications: [:primes]]
+    end
+    ```