move from https://github.com/c9/node-github3 to https://github.com/ajaxorg/node-github

Author: mikedeboer

LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2010 ajax.org B.V (Fabian Jakobs)
+Copyright (c) 2012 Cloud9 IDE, Inc. (Mike de Boer)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

NOTICE.txt

@@ -1,91 +1,114 @@
-# JavaScript GitHub API for node.js
+# JavaScript GitHub API for Node.JS
 
-A node.js module, which provides an object oriented wrapper for the GitHub v2 API. This library is a direct port of [php-github-api](http://github.com/ornicar/php-github-api) by Thibault Duplessis to JavaScript. The only major difference is that the JavaScript code is fully asynchronous.
+A Node.JS module, which provides an object oriented wrapper for the GitHub v3 API. 
 
 ## Installation
 
-  Install with the node package manager [npm](http://npmjs.org/):
+  Install with the Node.JS package manager [npm](http://npmjs.org/):
 
-      $ npm install github
+      $ npm install node-github
 
 or
 
   Install via git clone:
 
-      $ git clone git://github.com/ajaxorg/node-github.git
-      $ cd node-github
+      $ git clone git://github.com/c9/node-github3.git
+      $ cd node-github3
       $ npm install
 
+## Documentation
+
+You can find the docs for the API of this client at [http://c9.github.com/node-github3/](http://c9.github.com/node-github3/)
+
+Additionally, the [official Github documentation](http://developer.github.com/) 
+is a very useful resource.
+
 ## Example
 
-Print all followers of the user "fjakobs" to the console.
+Print all followers of the user "mikedeboer" to the console.
 
-    var GitHubApi = require("github").GitHubApi;
+    var GitHubApi = require("node-github");
 
-    var github = new GitHubApi(true);
-    github.getUserApi().getFollowers('fjakobs', function(err, followers) {
-        console.log(followers.join('\n'));
+    var github = new GitHubApi({
+        version: "3.0.0"
+    });
+    github.user.getFollowingFromUser({
+        user: "mikedeboer"
+    }, function(err, res) {
+        console.log(JSON.stringify(res));
     });
 
-First the _GitHubApi_ class is imported from the _github_ module. This class provides access to all of GitHub's APIs (e.g. user, commit or repository APIs). The _getFollowers_ method lists all followers of a given GitHub user. Is is part of the user API. It takes the user name as first argument and a callback as last argument. Once the follower list is returned from the server, the callback is called.
+First the _GitHubApi_ class is imported from the _node-github_ module. This class provides 
+access to all of GitHub's APIs (e.g. user, issues or repo APIs). The _getFollowingFromUser_ 
+method lists all followers of a given GitHub user. Is is part of the user API. It 
+takes the user name as first argument and a callback as last argument. Once the 
+follower list is returned from the server, the callback is called.
 
-Like in node.js callbacks are always the last argument. If the functions fails an error object is passed as first argument to the callback.
+Like in Node.JS, callbacks are always the last argument. If the functions fails an 
+error object is passed as first argument to the callback.
 
 ## Authentication
 
-Most GitHub API calls don't require authentication. As a rule of thumb: If you can see the information by visiting the site without being logged in, you don't have to be authenticated to retrieve the same information through the API. Of course calls, which change data or read sensitive information have to be authenticated.
+Most GitHub API calls don't require authentication. As a rule of thumb: If you 
+can see the information by visiting the site without being logged in, you don't 
+have to be authenticated to retrieve the same information through the API. Of 
+course calls, which change data or read sensitive information have to be authenticated.
 
-You need the GitHub user name and the API key for authentication. The API key can be found in the user's _Account Settings_ page.
+You need the GitHub user name and the API key for authentication. The API key can
+be found in the user's _Account Settings_ page.
 
-This example shows how to authenticate and then change _location_ field of the account settings to _Argentina_:
+This example shows how to authenticate and then change _location_ field of the 
+account settings to _Argentina_:
 
-    github.authenticate(username, token);
-    github.getUserApi().update(username, {location: "Argentina"}, function(err) {
+    github.authenticate({
+        type: "basic",
+        username: username,
+        password: password
+    });
+    github.user.update({
+        location: "Argentina"
+    }, function(err) {
         console.log("done!");
     });
 
-Note that the _authenticate_ method is synchronous because it only stores the credentials for the next request.
+Note that the _authenticate_ method is synchronous because it only stores the 
+credentials for the next request.
 
 ## Implemented GitHub APIs
 
-* User API: 100%
-* Commit API: 100%
-* Object API: 100%
-* Repository API: 90%, missing repo visibility, deploy keys
-* Issues API: 100%
-* Pulls API: only _getList_ is implemented
-* Gist API: 100% v1 Gist API implemented. 0% v3 API
-* Network API: still missing
+* Gists: 100%
+* Git Data: 100%
+* Issues: 100%
+* Orgs: 100%
+* Pull Requests: 100%
+* Repos: 100%
+* Users: 100%
+* Events: 100%
 
 ## Running the Tests
 
-The unit tests are based on the [node-async-test](http://github.com/bentomas/node-async-testing) module, which is provided as a git submodule. To run the tests make sure that the npm dependencies are installed by running `npm install` from the project directory.
+The unit tests are based on the [ayncjs](https://github.com/ajaxorg/async.js) 
+module, which is provided as an npm dependency. To run the tests make sure that the 
+npm dependencies are installed by running `npm install` from the project directory.
 
 Running all unit tests:
 
     npm test
 
 or
 
-    node lib/github_all_tests.js
+    node test/all.js
 
 The test classes can also be run separately. This will e.g. run the UserApi test:
 
-    node lib/github_test.js
+    node api/v3.0.0/userTest.js
 
 Note that a connection to the internet is required to run the tests.
 
 ## TODO
 
-* API docs
-  * fix and polish (there might still be some PHP-isms)
-  * generate API documentation
-* Documentation
+* generate Client documentation
 
 ## LICENSE
 
 MIT license. See the LICENSE file for details.
-
-## Credits
-
-Thanks to Thibault Duplessis for the excellent php-github-api library, which is the blueprint of this library. Especially the unit tests proved to be very helpful.

README.md

@@ -0,0 +1,3 @@
+{
+    
+}