commit-hash - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

package.json

 {
   "name": "commit-hash",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Get commit hash from a branch name, tag, or reference",
@@ -5,0 +5,0 @@ "homepage": "https://github.com/dgoguerra/commit-hash#readme",

readme.md

@@ -11,4 +11,29 @@ ## commit-hash
 
+### Usage
+
+```js
+var commitHash = require('commit-hash');
+
+// looking up a short commit hash, in a project in the current directory
+commitHash('21f6b', function(err, hash) {
+     console.log(hash); // => '21f6ba4e644e77d6e20eaa5156a928b6d75fdf76'
+});
+
+// looking up a tag with modifiers, in a project somewhere else
+commitHash('v0.1.0^^', {dir: '/home/dgo/repos/commit-hash'}, function(err, hash) {
+    console.log(hash); // => '285d19c23a56662bab97c75b4bfc80a175dfdae2'
+});
+
+// looking up a remote branch, after fetching from all remotes
+// to ensure the local repo has updated references
+commitHash('origin/tests-unused-branch', {
+    dir: '/home/dgo/repos/commit-hash',
+    fetch: true
+}, function(err, hash) {
+    console.log(hash); // => '3f07195438a6a846554ed4b8cd7b3223a8c5e91e'
+});
+```
+
 ### License
 
 MIT license - http://www.opensource.org/licenses/mit-license.php

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9368

increased by9.27%

Number of lines in readme file

39

increased by178.57%

No dependency changes