fix: docs, introduce tsup

NEARBuilders · Oct 20, 2024 · 709d004 · 709d004
1 parent ad373ac
commit 709d004
Show file tree

Hide file tree

Showing 13 changed files with 2,741 additions and 1,305 deletions.
diff --git a/.gitignore b/.gitignore
@@ -189,10 +189,12 @@ dist
 .vscode-test
 
 # yarn v2
-.yarn/cache
-.yarn/unplugged
-.yarn/build-state.yml
-.yarn/install-state.gz
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
 .pnp.*
 
 ### JetBrains template

diff --git a/README.md b/README.md
@@ -6,6 +6,14 @@
 <div align="center">
 
 <h1 style="font-size: 2.5rem; font-weight: bold;">near-social-js</h1>
+<p align="center">
+  <a href="https://npmjs.com/package/@builddao/near-social-js" target="_blank">
+    <img src="https://img.shields.io/npm/v/%40builddao%2Fnear-social-js?logo=npm" alt="npm" />
+  </a>
+  <a href="https://npmjs.com/package/@builddao/near-social-js" target="_blank">
+    <img src="https://img.shields.io/npm/dw/%40builddao%2Fnear-social-js?logo=npm&label=weekly%20downloads" alt="weekly npm downloads" />
+  </a>
+</p>
 
   <p>
     <strong>Typescript SDK for interacting with the social contract (social.near)</strong>

diff --git a/docs/advanced/fetching-indexed-data.mdx b/docs/advanced/fetching-indexed-data.mdx
@@ -46,58 +46,17 @@ A promise that resolves to an array of matched indexed values, ordered by blockH
 
 ### Basic Usage
 
-<Tabs
-  defaultValue="javascript-via-package-manager"
-  values={[
-    { label: 'JavaScript (via package manager)', value: 'javascript-via-package-manager' },
-    { label: 'JavaScript (via CDN)', value: 'javascript-via-cdn' },
-    { label: 'TypeScript', value: 'typescript' },
-  ]}>
-  <TabItem value="javascript-via-package-manager">
-
-    ```js
-    const { Social } = require('@builddao/near-social-js');
-
-    const social = new Social();
-    const result = await social.index({
-      action: 'like',
-      key: 'post-123',
-    });
-
-    console.log(result);
-    ```
-
-  </TabItem>
-  <TabItem value="javascript-via-cdn">
-
-    ```js
-    var social = new NEARSocialSDK();
-
-    social.index({
-      action: 'like',
-      key: 'post-123',
-    }).then((result) => {
-      console.log(result);
-    });
-    ```
-
-  </TabItem>
-  <TabItem value="typescript">
-
-    ```typescript
-    import { Social } from '@builddao/near-social-js';
-
-    const social = new Social();
-    const result = await social.index({
-      action: 'like',
-      key: 'post-123',
-    });
-
-    console.log(result);
-    ```
-
-  </TabItem>
-</Tabs>
+```typescript
+import { Social } from '@builddao/near-social-js';
+
+const social = new Social();
+const result = await social.index({
+  action: 'like',
+  key: 'post-123',
+});
+
+console.log(result);
+```
 
 ### Advanced Usage
 

diff --git a/docs/advanced/granting-write-permission.mdx b/docs/advanced/granting-write-permission.mdx
@@ -20,82 +20,25 @@ Accounts can grant write permission to other accounts for a set of keys.
 
 ## Granting an account write permission
 
-<Tabs
-  defaultValue="javascript-via-package-manager"
-  values={[
-    { label: 'JavaScript (via package manager)', value: 'javascript-via-package-manager' },
-    { label: 'JavaScript (via CDN)', value: 'javascript-via-cdn' },
-    { label: 'TypeScript', value: 'typescript' },
-  ]}>
-  <TabItem value="javascript-via-package-manager">
-
-    ```js
-    const { Social } = require('@builddao/near-social-js');
-
-    const social = new Social();
-    const transaction = await social.grantWritePermission({
-      account: {
-        accountID: 'bob.near',
-        publicKey: 'ed25519:H9k5eiU4xXS3M4z8HzKJSLaZdqGdGwBG49o7orNC4eZW',
-      },
-      granteeAccountId: 'alice.near',
-      keys: [
-        'alice.near/profile/name',
-        'alice.near/profile/image/url',
-      ],
-    });
-
-    // ...sign the returned transaction and post to the network
-    */
-    ```
-
-  </TabItem>
-  <TabItem value="javascript-via-cdn">
-
-    ```js
-    var social = new NEARSocialSDK();
-
-    social.grantWritePermission({
-      account: {
-        accountID: 'bob.near',
-        publicKey: 'ed25519:H9k5eiU4xXS3M4z8HzKJSLaZdqGdGwBG49o7orNC4eZW',
-      },
-      granteeAccountId: 'alice.near',
-      keys: [
-        'alice.near/profile/name',
-        'alice.near/profile/image/url'
-      ]
-    })
-    .then((transaction) => {
-      // ...sign the returned transaction and post to the network
-    });
-    ```
-
-  </TabItem>
-  <TabItem value="typescript">
-
-    ```typescript
-    import { Social } from '@builddao/near-social-js';
-
-    const social = new Social();
-    const transaction = await social.grantWritePermission({
-      account: {
-        accountID: 'bob.near',
-        publicKey: 'ed25519:H9k5eiU4xXS3M4z8HzKJSLaZdqGdGwBG49o7orNC4eZW',
-      },
-      granteeAccountId: 'alice.near',
-      keys: [
-        'alice.near/profile/name',
-        'alice.near/profile/image/url',
-      ],
-    });
-
-    // ...sign the returned transaction and post to the network
-    */
-    ```
-
-  </TabItem>
-</Tabs>
+```typescript
+import { Social } from '@builddao/near-social-js';
+
+const social = new Social();
+const transaction = await social.grantWritePermission({
+  account: {
+    accountID: 'bob.near',
+    publicKey: 'ed25519:H9k5eiU4xXS3M4z8HzKJSLaZdqGdGwBG49o7orNC4eZW',
+  },
+  granteeAccountId: 'alice.near',
+  keys: [
+    'alice.near/profile/name',
+    'alice.near/profile/image/url',
+  ],
+});
+
+// ...sign the returned transaction and post to the network
+*/
+```
 
 :::caution