From 58bd93dbd0220d83901576558e0a6dda4acd3288 Mon Sep 17 00:00:00 2001 From: Ben Busby Date: Sat, 11 Apr 2020 17:10:11 -0600 Subject: [PATCH] Update README.md --- README.md | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index dbffb9b..43ddf73 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Get Google search results, but without any ads, javascript, or AMP links. Easily - Running `docker ps` should return something besides an error. If you encounter an error saying the daemon isn't running, try `sudo systemctl start docker` (Linux) or ensure the docker tool is running (Windows/macOS). 2. Clone and deploy the docker app using a method below: -#### Using Heroku (Free) +#### A) Using Heroku (Free) ```bash heroku login heroku container:login @@ -26,11 +26,25 @@ heroku container:release web heroku open ``` -#### Using _____ -TODO +Now you're done! This series of commands can take a while, but once you run it once, you shouldn't have to run it again. The final command, `heroku open` will launch a tab in your web browser, where you can test out Shoogle and even [set it as your primary search engine](https://github.com/benbusby/shoogle#set-shoogle-as-your-primary-search-engine). + +#### B) Using your own server, or alternative container deployment +There are other methods for deploying docker containers that are well outlined in [this article](https://rollout.io/blog/the-shortlist-of-docker-hosting/), but there are too many to describe set up for each here. Generally it should be about the same amount of effort as the Heroku deployment. + +Depending on your preferences, you can also deploy the app yourself on your own infrastructure. This route would require a few extra steps: + - A server (I personally recommend [Digital Ocean](https://www.digitalocean.com/pricing/) or [Linode](https://www.linode.com/pricing/), their cheapest tiers will work fine) + - Your own URL (I suppose this is optional, but recommended) + - SSL certificates (free through [Let's Encrypt](https://letsencrypt.org/getting-started/)) + - A bit more experience or willingness to work through issues + +## Usage +Same as most search engines, with the exception of filtering by time range. + +To filter by a range of time, append ":past