@pythnetwork/client - npm Package Compare versions

Comparing version 1.0.5 to 1.0.6

CHANGELOG.md

 # Changelog
 
+## 1.0.6
+
+### Changed
+
+Updated README.md
+
 ## 1.0.5
@@ -4,0 +10,0 @@

package.json

 {
   "name": "@pythnetwork/client",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "Pyth price oracle data structures",
@@ -5,0 +5,0 @@ "homepage": "https://pyth.network",

README.md

@@ -1,2 +0,2 @@
-# pyth-client-js
+# @pythnetwork/client
 
@@ -11,22 +11,38 @@ ## A library for parsing on-chain Pyth oracle data
 
+## Installation
+
+### npm
+
+```
+$ npm install --save @pythnetwork/client
+```
+
+### Yarn
+
+```
+$ yarn add @pythnetwork/client
+```
+
 ## Example Usage
 
-```
+```javascript
 import { Connection, PublicKey } from '@solana/web3.js'
-import { parseMappingData, parsePriceData, parseProductData } from '@pythnetwork/pyth-client'
+import { parseMappingData, parsePriceData, parseProductData } from '@pythnetwork/client'
+
 const connection = new Connection(SOLANA_CLUSTER_URL)
-  const publicKey = new PublicKey(ORACLE_MAPPING_PUBLIC_KEY)
-  connection.getAccountInfo(publicKey).then((accountInfo) => {
-    const { productAccountKeys } = parseMappingData(accountInfo.data)
-    connection.getAccountInfo(productAccountKeys[productAccountKeys.length - 1]).then((accountInfo) => {
-      const { product, priceAccountKey } = parseProductData(accountInfo.data)
-      connection.getAccountInfo(priceAccountKey).then((accountInfo) => {
-        const { price, confidence } = parsePriceData(accountInfo.data)
-        console.log(`${product.symbol}: $${price} \xB1$${confidence}`)
-        // SRM/USD: $8.68725 ±$0.0131
-      })
+const publicKey = new PublicKey(ORACLE_MAPPING_PUBLIC_KEY)
+
+connection.getAccountInfo(publicKey).then((accountInfo) => {
+  const { productAccountKeys } = parseMappingData(accountInfo.data)
+  connection.getAccountInfo(productAccountKeys[productAccountKeys.length - 1]).then((accountInfo) => {
+    const { product, priceAccountKey } = parseProductData(accountInfo.data)
+    connection.getAccountInfo(priceAccountKey).then((accountInfo) => {
+      const { price, confidence } = parsePriceData(accountInfo.data)
+      console.log(`${product.symbol}: $${price} \xB1$${confidence}`)
+      // SRM/USD: $8.68725 ±$0.0131
     })
   })
+})
 ```
 
 To get streaming price updates, you may want to use `connection.onAccountChange`

No alert changes

Improved metrics

Total package byte prevSize

26291

increased by0.6%

Number of lines in readme file

48

increased by50%

No dependency changes