diff --git a/README.md b/README.md index 9986e3b0a..efcf72e2b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ ![Logo](static/logo.png "Logo") [![Build Status](https://circleci.com/gh/begriffs/postgrest.png?circle-token=f723c01686abf0364de1e2eaae5aff1f68bd3ff2)](https://circleci.com/gh/begriffs/postgrest/tree/master) + + Deploy + PostgREST serves a fully RESTful API from any existing PostgreSQL database. It provides a cleaner, more standards-compliant, faster @@ -148,5 +151,11 @@ and the [guide to routing](https://github.com/begriffs/postgrest/wiki/Routing). ### Thanks -Thanks to [Adam Baker](https://github.com/adambaker) for code -contributions and many fundamental design discussions. +* [Adam Baker](https://github.com/adambaker) for code + contributions and many fundamental design discussions +* [Miƫtek Bak](https://github.com/mietek) for creating the Heroku + deployment packaging and [Halcyon](https://halcyon.sh/) infrastructure +* [Nikita Volkov](https://github.com/nikita-volkov) for writing the + wonderful [Hasql](https://github.com/nikita-volkov/hasql) library + and helping me use it +* [Mikey Casalaina](https://github.com/casalaina) for the cool logo diff --git a/app.json b/app.json new file mode 100644 index 000000000..2e759ba5f --- /dev/null +++ b/app.json @@ -0,0 +1,45 @@ +{ + "name": "PostgREST", + "description": "RESTful API for any PostgreSQL database.", + "logo": "https://halcyon.sh/logo.svg", + "repository": "https://github.com/begriffs/postgrest", + "env": { + "BUILDPACK_URL": { + "description": "Heroku buildpack for deploying Haskell applications", + "value": "https://github.com/mietek/haskell-on-heroku" + }, + "DB_NAME": { + "description": "Database name" + }, + "DB_AUTH_ROLE": { + "description": "Database role to use checking client authentication" + }, + "DB_AUTH_PASS": { + "description": "Authentication password", + "required": false + }, + "DB_ANON_ROLE": { + "description": "Database role for non-authenticated requests" + }, + "DB_HOST": { + "description": "Database server hostname", + "required": false, + "value": "localhost" + }, + "DB_PORT": { + "description": "Database server port", + "required": false, + "value": "5432" + }, + "DB_POOL_SIZE": { + "description": "Maximum number of connections in database pool", + "required": false, + "value": "10" + }, + "DB_SECURE": { + "description": "Redirect all requests to HTTPS", + "required": false, + "value": "1" + } + } +} diff --git a/static/heroku.png b/static/heroku.png new file mode 100644 index 000000000..dc866e6e6 Binary files /dev/null and b/static/heroku.png differ