From 79f5c607eb2a557ca98800a96c475e3c0083da89 Mon Sep 17 00:00:00 2001 From: Ben Busby Date: Fri, 24 Apr 2020 18:06:28 -0600 Subject: [PATCH] Update README.md Added clarification for prerequisites if using the Heroku single-click deploy option --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f6356cc..49da1d7 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,14 @@ Get Google search results, but without any ads, javascript, AMP links, or tracki ![Shoogle Mobile](app/static/img/docs/screenshot_mobile.jpg) ## Prerequisites -- Docker ([Windows](https://docs.docker.com/docker-for-windows/install/), [macOS](https://docs.docker.com/docker-for-mac/install/), [Ubuntu](https://docs.docker.com/engine/install/ubuntu/), [other Linux distros](https://docs.docker.com/engine/install/binaries/)) - [A Heroku Account](https://www.heroku.com/) - - Optional, but recommended. Allows for free hosting of the web app. + - Optional, but recommended. Allows for free hosting of the web app and single-click deployment. - Alternatively, you can host the app using a different service, or deploy it to your own server (explained below). + +If deploying manually: +- Docker ([Windows](https://docs.docker.com/docker-for-windows/install/), [macOS](https://docs.docker.com/docker-for-mac/install/), [Ubuntu](https://docs.docker.com/engine/install/ubuntu/), [other Linux distros](https://docs.docker.com/engine/install/binaries/)) - [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) + - Only needed if you want to deploy the app to Heroku but don't want to use the deploy button shortcut. ## Setup 1. Ensure the Docker daemon is running, and is accessible by your user account