initial commit

1 files changed, 29 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..98ed818
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# gleam_json
+
+A Gleam program
+
+
+## Quick start
+
+```sh
+# Build the project
+rebar3 compile
+
+# Run the eunit tests
+rebar3 eunit
+
+# Run the Erlang REPL
+rebar3 shell
+```
+
+
+## Installation
+
+If [available in Hex](https://www.rebar3.org/docs/dependencies#section-declaring-dependencies)
+this package can be installed by adding `gleam_json` to your `rebar.config` dependencies:
+
+```erlang
+{deps, [
+    gleam_json
+]}.
+```