diff --git a/README.md b/README.md index 9cbb202..30cbbbd 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,61 @@ -Exposes `gh` to the global environment. Tries to follow both the form of Github -HTTP API and JS style. - - gh.authenticate("fitzgen", "sdfk32we-FAKE-uydfs7f-rhrwe8r7"); - var huddlej = gh.user("huddlej"); - huddlej.show(function (data) { - console.log(data.user); - }); - huddlej.repos(function (data) { - console.log("Number of repos: " + data.repositories.length); - }); - var wujs = gh.repo("fitzgen", "wu.js") - wujs.show(function (data) { - console.log("Number of watchers: " + data.repository.watchers); - }); - wujs.update({ has_wiki: 0 }); // Unfortunately, no callbacks with POSTs :( - -COMPLETE +Github API Js +=============== +This file has been modified and only works in environments that allow crossdomain scripting such as the BlackBerry Playbook with the WebWorks SDK. +You must also use jQuery to use this library. + +Exposes `gh` to the global environment. Tries to follow both the form of GithubHTTP API and JS style. + +You cannot load javascript files in using this library yet, as it gets the data from github inside `