From 6fe043e546c900787f03b9887085e5d1c2079211 Mon Sep 17 00:00:00 2001 From: Ansel Rosenberg Date: Wed, 16 Sep 2015 16:09:00 -0700 Subject: [PATCH] Clarify docs for 'username' parameter in user.show - The docs are unclear about how to retrieve user information for the currently authenticated user via GET '/user' vs GET /users/:username - Useful for identifying users via Github OAuth --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 84d870dc..da974f3c 100644 --- a/README.md +++ b/README.md @@ -230,7 +230,7 @@ List unread notifications for the authenticated user. user.notifications(function(err, notifications) {}); ``` -Show user information for a particular username. Also works for organizations. +Show user information for a particular username. Also works for organizations. Pass in a falsy value (null, '', etc) for 'username' to retrieve user information for the currently authorized user. ```js user.show(username, function(err, user) {});