From cc5fdb1d0a737ebae88983c148efa84054f2893c Mon Sep 17 00:00:00 2001 From: Sudhir Nimavat Date: Sat, 10 Aug 2013 08:56:52 +0530 Subject: [PATCH] Modified readme - Making 1.0 Release --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2b98322..bced531 100644 --- a/README.md +++ b/README.md @@ -19,21 +19,21 @@ Following configuration options are available. All of the config options are optional. See [facebook documentation](https://developers.facebook.com/docs/reference/plugins/comments/) for details about possible values. -## Integrating facebook comments into your application. +## Usage Follow this steps for integration -*Step 1* +**Step 1:** Put `` right after opening `` tag. It will initialize facebook comments js sdk. appId parameter is optional and if not specified it will be picked up from config. -*step 2* -put `` anywhere in the page where you want comments to be displayed. +**step 2:** +put `` in the page where you want comments to be displayed. Again all of the parameters are optional and if not specified they will be picked up from config. #### Configuring data-href url ----- -href parameter is used identify the page for comments. It can directly specified in `` tag, or it can be configured as a Closure in config. -When no href parameter is passed to `` tag, it will check if Closure is configured in config, if so, the closure will be called and return value will be used as href. +**href** parameter is used identify the page for comments. It can be directly specified in `` tag, or it can be configured as a Closure in config. +When no *href* parameter is passed to `` tag, it will check if Closure is configured, if so, the closure will be called and return value will be used as href. *Example* ``` @@ -49,4 +49,9 @@ And now in your gsp file ``` -When href is not passed as parameter to `` or not configured in Config.groovy, current request url will be used as href. +When *href* is not passed as parameter to `` or not configured in Config.groovy, current request url will be used as href. + + +**Note:** +Facebook comments are associated with a url, You will loose comments if you change *href* attribute of a comment box after some comments has been posted. +You can use `grails.plugin.facebookcomments.href` Closure configuration option to generate whatever url you want based on the bean passed. \ No newline at end of file