christkv/node-git

Documentation

beatgammit opened this issue · 3 comments

beatgammit commented

I couldn't find any documentation. It seems that there are some basic functions missing, namely:

  • push
  • pull
  • fetch
  • addRemote
  • reset

I haven't gone through them all though. Could there be documentation for each of the commands that are supported and parameter lists for each? I'd like to help, but it seems that many of the functions use the arguments global instead of actually naming parameters.

toddpi314 commented

I would love to see the branching APIs as well.

jankeromnes commented

I think that sadly nobody's in charge of documentation anymore. @christkv doesn't have time for it, and at the moment I'm just reviewing pull requests and making sure nothing breaks. If you read into the code and learn about some undocumented details, please write up some documentation, I'd be happy to merge it for you :)