update readme and add example environment file

Author: dervondenbergen

.example.env

@@ -0,0 +1,14 @@
+# server
+
+NODE_ENV="development" # or "production"
+PORT=1337
+IOPORT=1337 # should be different in production
+
+HTTPS_KEY="absolute/path/to/key.pem"
+HTTPS_CERT="absolute/path/to/cert.pem"
+
+# credentials
+
+TWILIO_ACCOUNT="<twilio accout sid>"
+TWILIO_SID="<twilio api key sid>"
+TWILIO_KEY="<twilio api key secret>"

README.md

@@ -1,12 +1,17 @@
 # joke.town 🤡 🏘
 
+## file structure
+
 [server.js](server.js): server code, run with Node.js
 
 [number.html](number.html): file which simply has a link to the phone number to
 show on https://joke.town
 
-[index.html](index.html): file which is the content of the screen, available at
-https://joke.town/screen
+[screen.html](screen.html): file which is the content of the screen, available
+at https://joke.town/screen
+
+[demo.html](demo.html): file which is the virtual joke.town consisting of the
+screen + buttons, available at https://joke.town/demo
 
 [big_keyboard.py](big_keyboard.py): DEPRECATED – this file was used to catch the
 button presses, but pretty ugly with a while loop
@@ -17,3 +22,14 @@ events instead of checking the satate in a while loop
 [assets/](assets/): all files needed by the screen page
 
 [data/](data/): the _database_, where users.json and jokes.json gets saved
+
+[.env](.env.example): the configuration file which contains all settings (has to
+be renamed to `.env`)
+
+## services
+
+joke.town uses Twilio to communicate via SMS. Twilio can be tested for free with
+this, get \$10 free when using my refferal link:
+[www.twilio.com/referral/X8xo9b](www.twilio.com/referral/X8xo9b)
+
+the service is hosted on [Uberspace](https://uberspace.de/)