aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAnhgelus Morhtuuzh <william@herges.fr>2025-11-04 12:16:57 +0100
committerAnhgelus Morhtuuzh <william@herges.fr>2025-11-04 12:16:57 +0100
commit24570e7bf215c79a55927f23a6735acd8cd0ff59 (patch)
tree9f04002e7d51a10c89a15fad97d4bf07a49ffd40 /README.md
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..31b80eb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# ElixirMathParser
+
+**TODO: Add description**
+
+## Installation
+
+If [available in Hex](https://hex.pm/docs/publish), the package can be installed
+by adding `elixir_math_parser` to your list of dependencies in `mix.exs`:
+
+```elixir
+def deps do
+ [
+ {:elixir_math_parser, "~> 0.1.0"}
+ ]
+end
+```
+
+Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
+and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
+be found at <https://hexdocs.pm/elixir_math_parser>.
+