fix: add browser usage example

bigchaindb · Mar 8, 2021 · 1d9de89 · 1d9de89
1 parent 46fe419
commit 1d9de89
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -43,6 +43,7 @@ This specification is only a draft at this stage and has not been submitted.
         - [Advanced: Parse a Condition](#advanced-parse-a-condition)
         - [Advanced: Parse and Reserialize a THRESHOLD-SHA-256 Fulfillment](#advanced-parse-and-reserialize-a-threshold-sha-256-fulfillment)
         - [Advanced: Manually Create a Condition](#advanced-manually-create-a-condition)
+        - [In browser environment](#in-browser-environment)
 
 ## API Documentation
 
@@ -320,3 +321,25 @@ myCondition.setCost(0)
 console.log(myCondition.serializeUri())
 // prints 'ni:///sha-256;47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU?fpt=preimage-sha-256&cost=0'
 ```
+
+### In browser environment
+
+```html
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>CryptoConditions</title>
+  </head>
+  <body>
+    <script src="https://unpkg.com/[email protected]/dist/browser/CryptoConditions.window.min.js"></script>
+    <script>
+      const conditionUri = 'ni:///sha-256;47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU?fpt=preimage-sha-256&cost=0'
+      const validationResult = CryptoConditions.validateCondition(condition)
+      console.log(`Condition ${conditionUri} is valid ? ${validationResult}`)
+      alert(JSON.stringify(CryptoConditions.Condition.fromUri(conditionUri), null, 2))
+    </script>
+  </body>
+</html>
+```
diff --git a/docs/README.template.md b/docs/README.template.md
@@ -298,3 +298,25 @@ myCondition.setCost(0)
 console.log(myCondition.serializeUri())
 // prints 'ni:///sha-256;47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU?fpt=preimage-sha-256&cost=0'
 ```
+
+### In browser environment
+
+```html
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>CryptoConditions</title>
+  </head>
+  <body>
+    <script src="https://unpkg.com/[email protected]/dist/browser/CryptoConditions.window.min.js"></script>
+    <script>
+      const conditionUri = 'ni:///sha-256;47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU?fpt=preimage-sha-256&cost=0'
+      const validationResult = CryptoConditions.validateCondition(condition)
+      console.log(`Condition ${conditionUri} is valid ? ${validationResult}`)
+      alert(JSON.stringify(CryptoConditions.Condition.fromUri(conditionUri), null, 2))
+    </script>
+  </body>
+</html>
+```