Merge pull request #13 from cslzchen/feature/update-readme

[SVCS-945] Update README.md

README.md

@@ -1,16 +1,33 @@
-# Fake CAS
+# Run fakeCAS with OSF
 
-Download the binary from [here](https://github.com/CenterForOpenScience/fakecas/releases/latest)
+Please follow [README-docker-compose.md](https://github.com/CenterForOpenScience/osf.io/blob/develop/README-docker-compose.md) to run fakeCAS with OSF.
 
-```bash
-cd ~/Downloads # cd to where you downloaded the file to
-chmod +x fakecas # Make the server executable
-./fakecas # Run the server
+## Change the Image
 
-./fakecas -h  # Print possible configuration options
-# Usage of ./fakecas:
-#   -dbaddress="localhost:27017": The address of your mongodb. ie: localhost:27017
-#   -dbname="osf20130903": The name of your OSF database
-#   -host="localhost:8080": The host to bind to
-#   -osfhost="localhost:5000": The osf host to bind to
+By default, OSF uses the `master` image of fakeCAS, as shown below in [docker-compose.yml](https://github.com/CenterForOpenScience/osf.io/blob/develop/docker-compose.yml).
+
+```yml
+##################################
+# Central Authentication Service #
+##################################
+
+fakecas:
+  image: quay.io/centerforopenscience/fakecas:master
+  command: fakecas -host=0.0.0.0:8080 -osfhost=localhost:5000 -dbaddress=postgres://postgres@postgres:5432/osf?sslmode=disable
+  restart: unless-stopped
+  ports:
+    - 8080:8080
+  depends_on:
+    - postgres
+  stdin_open: true
 ```
+
+If you need the `develop` one, use `quay.io/centerforopenscience/fakecas:develop` instead. Run `docker-compose pull fakecas` to pull the new image before starting `docker-compose pull fakecas`.
+
+## Pre-docker-compose
+
+Starting [18.0.0](https://github.com/CenterForOpenScience/fakecas/milestone/1), fakeCAS no longer provides downloadable binrary executables. Here is the last version [0.11.1](https://github.com/CenterForOpenScience/fakecas/releases/tag/0.11.1) that provides such a binary.
+
+# Develop fakeCAS
+
+Please take a look at the [Dockerfile](https://github.com/cslzchen/fakecas/blob/develop/Dockerfile) for how to develop fakeCAS locally. On macOS, use [`brew`](https://github.com/Homebrew/brew) to install [`go`](https://github.com/golang/go) and [`glide`](https://github.com/Masterminds/glide).