Skip to content

Commit

Permalink
added lic. details to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Falicon authored and mozillamonks committed Jan 2, 2011
1 parent 232a1bb commit 5df7d56
Showing 1 changed file with 35 additions and 3 deletions.
38 changes: 35 additions & 3 deletions 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

Expand Down Expand Up @@ -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:

Expand All @@ -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 <http://www.gnu.org/licenses/>.

0 comments on commit 5df7d56

Please sign in to comment.