aboutsummaryrefslogtreecommitdiff
path: root/examples/server_demo/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/server_demo/README.md')
-rw-r--r--examples/server_demo/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/examples/server_demo/README.md b/examples/server_demo/README.md
new file mode 100644
index 0000000..c0d6a2a
--- /dev/null
+++ b/examples/server_demo/README.md
@@ -0,0 +1,22 @@
+# server_demo
+
+[![Package Version](https://img.shields.io/hexpm/v/server_demo)](https://hex.pm/packages/server_demo)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/server_demo/)
+
+## Quick start
+
+```sh
+gleam run # Run the project
+gleam test # Run the tests
+gleam shell # Run an Erlang shell
+```
+
+## Installation
+
+If available on Hex this package can be added to your Gleam project:
+
+```sh
+gleam add server_demo
+```
+
+and its documentation can be found at <https://hexdocs.pm/server_demo>.