Skip to content

Added support for node.js / require() #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Added support for node.js / require() #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f53d4a
Added support for require() / node.js
stdclass May 10, 2012
ca9ec19
Updated README for Node.js usage
stdclass May 10, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ repo.write('master', 'path/to/file', 'YOUR_NEW_CONTENTS', 'YOUR_COMMIT_MESSAGE',
Not only can you can write files, you can of course read them.

```js
// Retrieve contents of a certain file (assumes UTF-8)

repo.read('master', 'path/to/file', function(err, data) {

});
Expand All @@ -43,9 +45,23 @@ repo.read('master', 'path/to/file', function(err, data) {
Listing all files of a repository is easy too.

```js
// Retrieve contents of a certain file (assumes UTF-8)

repo.list('master', 'path/to/file', function(err, data) {

});
```
```


Node.js
--------------

To use Github.js on a node.js server, include it with require():

```js
var Github = require("/path/to/github.js");

var github = new Github({
username: "YOU_USER",
password: "YOUR_PASSWORD",
auth: "basic"
});
```
20 changes: 17 additions & 3 deletions github.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
// http://substance.io/michael/github

(function() {
var Github;

var API_URL = 'https://api.github.com';

Github = window.Github = function(options) {
var Github = function(options) {
var username = options.username;
var password = options.password;

Expand Down Expand Up @@ -236,4 +236,18 @@
return new Github.User();
};
};

// Export the Github object for Node.js, with
// backwards-compatibility for the old `require()` API. If we're in
// the browser, add `Github` as a global object via a string identifier,
// for Closure Compiler "advanced" mode.
if (typeof exports !== "undefined") {
if (typeof module !== "undefined" && module.exports) {
exports = module.exports = Github;
}
exports.Github = Github;
} else {
this['Github'] = Github;
}

}).call(this);