Add readme

Explain how to setup the app.
piku · Feb 9, 2023 · c8409f5 · c8409f5
1 parent 7433164
commit c8409f5
Showing 1 changed file with 18 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,18 @@
-# sample-ruby-app
+# Sample Ruby Application for `piku`
+
+> Contributed by @ewalk153
+
+This is a simple ruby [Sinatra](https://sinatrarb.com) that demonstrates running a ruby application on `piku`.
+
+To publish this app to `piku`, clone this repository run the following commands:
+
+```bash
+git remote add piku piku@your_server:sample-ruby-app
+git push piku main
+```
+
+Then you can set up an SSL cert and connect a domain by setting config variables like this:
+
+```bash
+ssh piku@your_server config:set sample-ruby-app NGINX_SERVER_NAME=your_server
+```