From 524a81ca9f68da2473c22420b49ddbe713bd43ef Mon Sep 17 00:00:00 2001
From: Michael Bumann <hello@michaelbumann.com>
Date: Mon, 6 Apr 2020 09:20:39 +0000
Subject: [PATCH] Update README.md

---
 README.md | 39 ++++++++++++++++++++++++++-------------
 1 file changed, 26 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 7db80e4..c443643 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,37 @@
-# README
+# Tinyforms
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+Form endpoint that allows to push data from a static HTML form directly into a google spreadsheet.
 
-Things you may want to cover:
+## Installation
 
-* Ruby version
+### Requirements
 
-* System dependencies
+* ruby 2.6 or higher
+* PostgreSQL
 
-* Configuration
+### Installation
 
-* Database creation
+Install gem dependencies and setup the database:
 
-* Database initialization
+   ```bash
+   $ bundle install
+   $ rails db:setup
+   ```
 
-* How to run the test suite
+### Configration
 
-* Services (job queues, cache servers, search engines, etc.)
+To use the application the Google API client needs to be configured using the following environment variables:
 
-* Deployment instructions
+* GOOGLE_CLIENT_ID
+* GOOGLE_PROJECT_ID
+* GOOGLE_CLIENT_SECRET
 
-* ...
+You can get those from the [Google APIs Dashboard](https://console.developers.google.com/apis/dashboard)
+
+Store those in a `.env` file; see `env.example` for an example.
+
+### Run the application
+
+    $ rails server # loads the configruation from the .env file
+
+Open [localhost:3000](http://localhost:3000)