@webbtc/webln-types - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "@webbtc/webln-types",
   "description": "Type definitions for WebLN",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "types": "types/index.d.ts",
@@ -14,3 +14,4 @@ "repository": {
   "scripts": {
-    "publish": "npm publish --access public"
+    "npm:bump-version": "npm version patch",
+    "npm:publish": "npm publish --access public"
   },
@@ -17,0 +18,0 @@ "bugs": {

README.md

 # webln-types
 
-Type definitions for WebLN
+Type definitions for [WebLN](https://webbtc.dev/webln)
 
+## Quick Start
+
+1. Install package
+
+```bash
+ npm install @webbtc/webln-types --save-dev # or yarn add @webbtc/webln-types --dev
+```
+
+2. Add the following line somewhere in your codebase (e.g. the main/index.tsx file)
+
+```javascript
+/// <reference types="@webbtc/webln-types" />
+```
+
+3. Type definitions are now available for `window.webln`
+
+```javascript
+if (window.webln) {
+  (async () => {
+    await window.webln.enable();
+    console.log(await window.webln.getInfo());
+  })();
+} else {
+  console.warn("WebLN not enabled");
+}
+```
+
+## Adding WebLN to your application
+
 Read the [WebLN Guide](https://www.webln.guide/introduction/readme)

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

4649

increased by16.17%

Number of lines in readme file

35

increased by483.33%

No dependency changes