Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Add some minimal documentation for latest code.

  • Loading branch information...
commit 28982b9f4d49faa45f83665422bd8c42bf66e563 1 parent 5850fc7
@meitar authored
Showing with 19 additions and 1 deletion.
  1. +19 −1 README.markdown
View
20 README.markdown
@@ -2,7 +2,25 @@
`libFetLife` is a PHP class implementing a simple API that can be used to interface with the social networking website [FetLife.com](https://fetlife.com/).
-This is, of course, a work in progress. Patches welcome.
+## Getting started
+
+To use `libFetLife`, include it in your project and instantiate a new `FetLifeUser` object:
+
+ // Load FetLife API.
+ require_once('libFetLife/FetLife.php');
+
+ // Log in as a user.
+ $FL = new FetLifeUser('username', 'password');
+ $FL->logIn();
+
+ // Print some basic information about the account you're using.
+ print $FL->id; // your user's numeric ID.
+
+ // Query FetLife for information about other users.
+ print $FL->getUserIdByNickname('JohnBaku'); // prints "1"
+ print $FL->getUserNicknameById('1254'); // prints "maymay"
+
+[Patches welcome](https://github.com/meitar/libFetLife/issues/new).
## Projects that use libFetLife
Please sign in to comment.
Something went wrong with that request. Please try again.