aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorElizabeth Hunt <elizabeth.hunt@simponic.xyz>2023-10-01 20:41:48 -0600
committerElizabeth Hunt <elizabeth.hunt@simponic.xyz>2023-10-01 20:41:48 -0600
commitffa3d553f693494c218a0244c946ba83dfbf7cd1 (patch)
tree092a824dad118c37960ab67da98cdbc445a35d2b /README.md
downloadtronglessh-main.tar.gz
tronglessh-main.zip
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..829b05c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# TrongleSSH
+
+**TODO: Add description**
+
+## Installation
+
+If [available in Hex](https://hex.pm/docs/publish), the package can be installed
+by adding `tronglessh` to your list of dependencies in `mix.exs`:
+
+```elixir
+def deps do
+ [
+ {:tronglessh, "~> 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/tronglessh>.
+