gabrielcsapo / node-git-server

🎡 A configurable git server written in Node.js
https://gabrielcsapo.github.io/node-git-server
MIT License
253 stars 73 forks source link

Update docs for user() #71

Closed chmac closed 4 years ago

chmac commented 4 years ago

From my local tests, and as I read the code here:

https://github.com/gabrielcsapo/node-git-server/blob/5279f64b200b3d8e8f3d537c28c86793033e6285/lib/git.js#L307

I think that the docs are incorrect. The authenticate() option gets a function called user() which accepts a callback, and invokes that callback with the username, password, and maybe error properties. I've updated the docs to reflect this. But, I'm entirely new to the codebase, so I would recommend a thorough review of my changes to see if they really do make sense.