summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLeon Overweel <l.overweel@gmail.com>2017-02-10 04:54:50 +0100
committerGitHub <noreply@github.com>2017-02-10 04:54:50 +0100
commitf8cdedb9f9a83724aa7b4d484fda6e2ee1fb4819 (patch)
tree07bfe207f6146a71bef42676a6e084d355aebdc7
parent670b7718bd471828df38e1faff21bfbd19d42263 (diff)
parent488bb1274c261c55d546989bfc8529b9831a5a26 (diff)
Merge pull request #3 from sacheendra/master
Add Docker installation steps to README
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index be0c4c80..2ae6d927 100644
--- a/README.md
+++ b/README.md
@@ -20,7 +20,13 @@ The official way to run OpenDC is using Docker. Other options include building a
For all of these options, you have to create a Google API Console project and client ID, which the OpenDC frontend and web server will use to authenticate users and requests. Follow [these steps](https://developers.google.com/identity/sign-in/web/devconsole-project) to make such a project. Download the JSON of the OAuth 2.0 client ID you created from the Credentials tab, and specifically note the `client_id` and the `client_secret`, which you'll need to build OpenDC.
-### Running OpenDC locally
+### Installing Docker
+
+GNU/Linux, macOS and Windows 10 Professional users can install Docker by following the instructions [here](https://www.docker.com/products/docker).
+
+Users of Windows 10 Home and previous editions of windows can use [Docker Toolbox](https://www.docker.com/products/docker-toolbox).
+
+### Running OpenDC
To build and run the full OpenDC stack locally on Linux or Mac, run the commands bellow. Replace `your-google-oauth-client-id` with your `client_id` from the OAuth 2.0 client ID you created, and replace `your-google-oauth-secret` with your `client_secret`.