Skip to content
This repository has been archived by the owner on Nov 8, 2021. It is now read-only.

Commit

Permalink
README Change
Browse files Browse the repository at this point in the history
  • Loading branch information
benorama committed Sep 11, 2010
1 parent 93461c7 commit b3f8c81
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .gitignore
@@ -1,3 +1,4 @@
/settings.xml
/.project
/.settings/org.eclipse.core.resources.prefs
/.settings/org.eclipse.core.resources.prefs
.DS_Store
51 changes: 51 additions & 0 deletions README
@@ -0,0 +1,51 @@
**[[Home]]** | [[Installation]] | [[Usage]] | [[Examples]]

Welcome to the **Facebook ColdFusion SDK** Wiki documentation.

# Introduction

The [[Facebook Platform|http://developers.facebook.com/]] is a set of APIs that make your application more social. Read more about [[integrating Facebook with your web site|http://developers.facebook.com/docs/guides/web]] on the Facebook developer site.

This project contains the open source **Facebook ColdFusion SDK** that allows you to integrate the [[Facebook Platform|http://developers.facebook.com/]] on your website powered by a [[ColdFusion application server|http://www.adobe.com/products/coldfusion]].

Facebook ColdFusion SDK provides 3 components :

* **FacebookApp.cfc** - A library to build iFrame/FBML [[apps on Facebook.com|http://developers.facebook.com/docs/guides/canvas/]] and [[websites with the Facebook Platform|http://developers.facebook.com/docs/guides/web]] (the library is a complete port to ColdFusion of the [[Facebook PHP SDK V2.1.1|http://github.com/facebook/php-sdk]]).
* **FacebookGraphAPI.cfc** - A client wrapper to call Facebook Graph API (the wrapper is inspired from the latest official .NET and Python SDKs graph clients).
* **FacebookRestAPI.cfc** - A client wrapper to call the old Facebook Rest API.

# Getting started

1. You must first [[Download|http://github.com/benorama/facebook-cf-sdk/downloads]] the latest version of the SDK.
2. [[Install the SDK|Installation]] on your ColdFusion server.
3. [[Use the components|Usage]] in your application.

To see the SDK in action, check the [[examples]].

# Documentation

To view the latest SDK documentation, please use the project [[Wiki|http://github.com/benorama/facebook-cf-sdk/wiki]] section on GitHub.

# Downloads

To download the latest version of the SDK, please use the project [[Downloads|http://github.com/benorama/facebook-cf-sdk/issues]] section on GitHub.

# Bugs

To report any bug, please use the project [[Issues|http://github.com/benorama/facebook-cf-sdk/issues]] section on GitHub.

# Beta status

This is a **beta release**.
In order to guide the development of the library, we have open-sourced the library.
The underlying APIs are generally stable, however we may make changes to the library in response to developer feedback.

# Feedback

The **Facebook ColdFusion SDK** is not an official Facebook SDK such as [[Javascript|http://developers.facebook.com/docs/reference/javascript/]], [[PHP|http://github.com/facebook/php-sdk]], [[Python|http://github.com/facebook/python-sdk/]], [[iOS|http://github.com/facebook/facebook-ios-sdk/]] and [[Android SDKs|http://github.com/facebook/facebook-android-sdk]].

It is developped by [[Affinitiz|http://poweredby.affinitiz.com]], a french social media web agency.

The Facebook ColdFusion SDK is licensed under the [[Apache Licence, Version 2.0|http://www.apache.org/licenses/LICENSE-2.0.html]].

*Credits: logo based on ColdFusion Wallpaper - Revolution by [[Angry Fly|http://angry-fly.com/]].*

0 comments on commit b3f8c81

Please sign in to comment.