summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSimponic <loganhunt@simponic.xyz>2022-12-19 01:37:10 -0700
committerSimponic <loganhunt@simponic.xyz>2022-12-19 01:39:10 -0700
commit9cdfb6eb9cd30c4e06a7d9fef53e519983827d81 (patch)
tree4622a1809df6a6424f1b5f9f10c72dd02f9fc176 /README.md
downloadchessh-9cdfb6eb9cd30c4e06a7d9fef53e519983827d81.tar.gz
chessh-9cdfb6eb9cd30c4e06a7d9fef53e519983827d81.zip
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..e4aaab9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Server
+
+**TODO: Add description**
+
+## Installation
+
+If [available in Hex](https://hex.pm/docs/publish), the package can be installed
+by adding `server` to your list of dependencies in `mix.exs`:
+
+```elixir
+def deps do
+ [
+ {:server, "~> 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/server>.
+