From 2defcdc633b7d166ea7023bfd050ce731472678d Mon Sep 17 00:00:00 2001 From: Nick Sergeant Date: Thu, 3 Nov 2016 12:34:09 -0400 Subject: [PATCH] Readme. --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e523ca4..51b0eb6 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,29 @@ *Automatic:* +You can click the button below to automatically deploy Snipt to Heroku. + [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/nicksergeant/snipt/tree/heroku) +*Please note:* this method will work fine, but you will not have email support +unless you manually configure Postmark. You don't necessarily need this, +though. After deploying the instance, visit +`https:///signup`, and create a user. You will get a 500 +Server Error, which is the site trying to send a welcome email. Ignore the +error and go to `/login`, and log in with the +username and password you provided. Snipt will work fine, but you will not +receive any emails if there are server errors. + +If you would like to configure your instance to use a free Postmark addon, do +the following after deploying: + +- `git clone https://github.com/nicksergeant/snipt.git` +- `cd snipt` +- `heroku git:remote -a ` +- `heroku addons:create postmark:10k` +- `heroku addons:open postmark` -> use an email you control and confirm it +- `heroku config:add POSTMARK_EMAIL=` + *Manual:* - Clone the repo. @@ -13,7 +34,7 @@ - `heroku addons:add heroku-postgresql:hobby-dev` - `heroku addons:add searchbox` - `heroku addons:create postmark:10k` -- `heroku addons:open postmark` -> use an email you control +- `heroku addons:open postmark` -> use an email you control and confirm it - `heroku config:add POSTMARK_EMAIL=` - `heroku config:add SECRET_KEY=` - `git push heroku`