diff --git a/README.md b/README.md index bdfd7a2..b91a381 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ -#Facebook client +# Facebook client [![Build Status](https://travis-ci.org/jvm-bloggers/jvm-bloggers-facebook-client.svg?branch=master)](https://travis-ci.org/jvm-bloggers/jvm-bloggers-facebook-client) -##Configuration +## Configuration The application requires two parameters at startup: application secret and user access token. -###Application secret +### Application secret To get the application secret you have to be in admin role of [JVM Bloggers on Facebook](https://www.facebook.com/jvmbloggers). Go to [the application dashboard](https://developers.facebook.com/apps/984518258323702/dashboard/). The secret is placed on the main page of it. -###Access token +### Access token To grab a user access token two calls have to be made to Facebook Graph API: * the first one for an authentication code: `GET https://www.facebook.com/dialog/oauth?client_id={app-id}&redirect_uri={redirect-uri}&scope=manage_pages,publish_pages` @@ -22,19 +22,19 @@ To grab a user access token two calls have to be made to Facebook Graph API: `{redirect-uri}` can be anything based on *App Domain* defined on [the application settings page](https://developers.facebook.com/apps/984518258323702/settings/). -##Running +## Running You need to **have kafka running** on the address specified in application.conf (by default localhost:9092) before starting the service. -###Docker +### Docker To generate a Docker image simply run: `./gradlew buildDocker` The application as a Docker container can be started with the following command: `docker run -e APP_SECRET=... -e ACCESS_TOKEN=... docker_image_name` -###IDE +### IDE You can start the application from IDE as well. The main class is `com.jvm_bloggers.facebook.client.Application`. -Two VM parameters have to be provided: `-Dfacebook.app.secret=...` and `-Dfacebook.user.access.token=...` \ No newline at end of file +Two VM parameters have to be provided: `-Dfacebook.app.secret=...` and `-Dfacebook.user.access.token=...`