Adding details to readme and package.json

davidplumridge · May 8, 2024 · 9e507c2 · 9e507c2
1 parent efeab7d
commit 9e507c2
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Shopify HMAC Validator
 
-A lightweight package to validate Shopify HMAC codes
+A lightweight package for validating Shopify HMAC codes for user and webhook requests.
 
 ## Usage
 
@@ -14,6 +14,6 @@ A lightweight package to validate Shopify HMAC codes
     const { isShopifyWebhookHmacValid } = require('shopify-hmac-validator')
     isShopifyWebhookHmacValid("my_secret", "full_query_string")
 
-## More examples
+### More examples
 
-See the repo __tests__ for more examples.
+See the __tests__ folder in the repo for more examples.
diff --git a/package.json b/package.json
@@ -10,7 +10,11 @@
   "keywords": ["Shopify", "HMAC", "Validation", "Validator", "Webhook", "Installation"],
   "author": "David Plumridge",
   "license": "MIT",
-  "description": "",
+  "description": "A lightweight package for validating Shopify HMAC codes for user and webhook requests.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/davidplumridge/shopify-hmac-validator"
+  },
   "devDependencies": {
     "@babel/core": "^7.24.5",
     "@babel/preset-env": "^7.24.5",
@@ -21,4 +25,4 @@
     "ts-node": "^10.9.2",
     "typescript": "^5.4.5"
   }
-}
+}