From 5df7d56a004055ccaae47018b480ea4721f789f3 Mon Sep 17 00:00:00 2001 From: Kevin Marshall Date: Thu, 30 Dec 2010 10:40:29 +0800 Subject: [PATCH] added lic. details to README --- README.txt | 38 +++++++++++++++++++++++++++++++++++--- 1 file changed, 35 insertions(+), 3 deletions(-) diff --git a/README.txt b/README.txt index 799574b..dca18bb 100644 --- a/README.txt +++ b/README.txt @@ -1,9 +1,15 @@ This is a very simple PHP library for interacting with the v3 bit.ly api (only deals with JSON format, but supports new OAuth endpoints) -REQUIREMENTS: PHP, Curl, JSON +============== +REQUIREMENTS: +============== -USEAGE: +PHP, Curl, JSON + +====== +USAGE: +====== 1. Simply download the bitly.php file and include it in your project directory @@ -53,8 +59,9 @@ $results = bitly_v3_user_countries('USERS_ACCESS_TOKEN'); $results = bitly_v3_user_realtime_links('USERS_ACCESS_TOKEN'); - +============= SPECIAL NOTE: +============= To use the new OAuth endpoints, you must first obtain an access token for a user. You do this by passing the user off to bit.ly to approve your apps access to their account...and then you use the return code along with the bitly_oauth_access_token method to obtain the actual bitly access token: @@ -64,10 +71,35 @@ To use the new OAuth endpoints, you must first obtain an access token for a user 3. If everything goes correctly, you should now have a $results['access_token'] value that you can use with the oauth requests for that user. +============== +SPECIAL THANKS: +============== +Robin Monks (https://github.com/mozillamonks) - for great additional documentation and general suggestions/improvements. + +======= CONTACT: +======= As always, if you've got any questions, comments, or concerns about anything you find here, please feel free to drop me an email at info@falicon.com or find me on Twitter @falicon +======= +License: +======= + +Copyright 2010 Kevin Marshall. + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .