git-repo-info - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "git-repo-info",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Retrieve current sha and branch name from a git repo.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 ## git-repo-info
 
-Retrieves repo information.
+Retrieves repo information without relying on the `git` command.
+
+### Usage
+
+```javascript
+var getRepoInfo = require('git-repo-info');
+
+var info = getRepoInfo();
+
+info.branch         //=> will be the current branch
+info.sha            //=> will be the current sha
+info.abbreviatedSha //=> will be the first 10 chars of the current sha
+```
+
+When called without any arguments, `git-repo-info` will automatically lookup upwards
+into parent directories to find the first match with a `.git` folder.
+
+If passed an argument, it will be assumed to be the path to the repo's `.git` folder
+to inspect.

No alert changes

Improved metrics

Total package byte prevSize

4939

12.92%

Number of lines in readme file

22

450%

No dependency changes