Repository navigation
Example on nodegit.com homepage is invalid #211
Description
I looked through the repo for the nodegit.org homepage in an attempt to submit a PR, but it doesn't look like that content is maintained here.
/* http://www.nodegit.org/ */
// Load in the module.
var git = require('nodegit'),
async = require('async');
// Open the repository in the current directory.
git.repo('.git', function(error, repository) {In this example taken from the homepage, an exception would be thrown because there is no "repo" method on the git object, or it's prototype.
The correct usage should be git.Repo().
Activity
jeffwilcox commentedon Aug 22, 2014
I was just wondering the same thing, had a lot of trouble getting started experimenting with nodegit as the homepage and the README.md feel out of date.
Hopefully someone is taking a look.
DrewML commentedon Sep 2, 2014
Replying to my own comment(and for @jeffwilcox) it looks like PR's for the docs can be submitted to this repo: https://github.com/nodegit/nodegit.github.com/tree/redesign. I'll try and submit an update soon for the issue I reported.
tbranyen commentedon Oct 24, 2014
Docs have been updated.