docs: update README

RSS3-Network · Jun 17, 2024 · 53f1e29 · 53f1e29
1 parent 7fb7cc2
commit 53f1e29
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -1,15 +1,15 @@
-<!-- markdownlint-disable -->
 <p align="center">
-  <svg width="104" height="24" viewBox="0 0 104 24" fill="none" xmlns="http://www.w3.org/2000/svg"><g clip-path="url(#clip0_8747_12063)"><path d="M22.893 0.222656H1.36317C0.964698 0.222656 0.638672 0.543314 0.638672 0.962636V23.1867C0.638672 23.5937 0.964698 23.9267 1.36317 23.9267H22.893C23.2914 23.9267 23.6175 23.5937 23.6175 23.1867V0.962636C23.6175 0.555647 23.2914 0.222656 22.893 0.222656ZM20.5625 20.0541C20.4779 20.1898 20.333 20.2761 20.1761 20.2761H16.7709C16.6019 20.2761 16.4449 20.1774 16.3724 20.0171L14.4404 16.0459C14.3076 15.7869 14.042 15.6142 13.7522 15.6142H7.87161C7.75086 15.6142 7.65426 15.7129 7.65426 15.8362V19.8321C7.65426 20.0911 7.44899 20.2884 7.20749 20.2884H4.51476C4.26118 20.2884 4.06798 20.0788 4.06798 19.8321V12.4077C4.06798 12.1487 4.27326 11.9513 4.51476 11.9513H13.571C13.8971 11.9513 14.1748 11.68 14.1748 11.3347V8.17744C14.1748 7.84445 13.9091 7.56079 13.571 7.56079H4.51476C4.26118 7.56079 4.06798 7.35113 4.06798 7.10447V4.35421C4.06798 4.09522 4.27326 3.89789 4.51476 3.89789H13.9937C14.2472 3.89789 14.4404 4.10755 14.4404 4.35421V6.53715C14.4404 6.87014 14.7061 7.1538 15.0442 7.1538H17.3143C17.5679 7.1538 17.7611 7.36346 17.7611 7.61012V11.902C17.7611 12.161 17.5558 12.3583 17.3143 12.3583H15.0442C14.7182 12.3583 14.4404 12.6296 14.4404 12.975V14.5536C14.4404 14.9852 14.7785 15.3306 15.2012 15.3306H18.1958C18.3648 15.3306 18.5218 15.4292 18.5942 15.5896L20.5625 19.6225C20.6349 19.7704 20.6228 19.9308 20.5383 20.0664L20.5625 20.0541Z" fill="#1477fb"></path><path d="M60.6266 10.6434L55.8328 10.0021C54.6253 9.82939 53.2487 9.08941 52.8261 7.54779C52.2465 5.40185 53.9974 3.32991 56.1709 3.32991H58.7308C61.0854 3.32991 62.2688 5.57451 62.3654 7.64645V7.79445H65.8309V7.63412C65.6136 2.63926 62.6914 0 57.3784 0C52.3431 0 49.3485 2.55293 49.3485 6.82014C49.3485 10.372 51.4616 12.7646 54.9996 13.2456L59.8659 13.9239C61.665 14.1336 62.8242 15.4286 62.8242 17.2415C62.8242 19.2641 61.3994 20.6701 59.3587 20.6701H56.0985C53.5748 20.6701 52.4276 18.3762 52.2224 16.4029V16.2672H48.7568V16.4275C48.8655 21.4471 51.8601 23.9877 57.6682 23.9877C63.102 23.9877 66.2173 21.4347 66.2173 16.9825C66.2173 13.3936 64.237 11.1367 60.6387 10.6187L60.6266 10.6434Z" fill="#1477fb"></path><path d="M79.5485 10.6434L74.7547 10.0021C73.5472 9.82939 72.1706 9.08941 71.748 7.54779C71.1684 5.40185 72.9193 3.32991 75.0928 3.32991H77.6527C80.0073 3.32991 81.1907 5.57451 81.2873 7.64645V7.79445H84.7528V7.63412C84.5355 2.63926 81.6133 0 76.3003 0C71.265 0 68.2704 2.55293 68.2704 6.82014C68.2704 10.372 70.3835 12.7646 73.9215 13.2456L78.7877 13.9239C80.5869 14.1336 81.7461 15.4286 81.7461 17.2415C81.7461 19.2641 80.3213 20.6701 78.2806 20.6701H75.0203C72.4966 20.6701 71.3495 18.3762 71.1442 16.4029V16.2672H67.6787V16.4275C67.7874 21.4471 70.782 23.9877 76.5901 23.9877C82.0238 23.9877 85.1392 21.4347 85.1392 16.9825C85.1392 13.3936 83.1589 11.1367 79.5605 10.6187L79.5485 10.6434Z" fill="#1477fb"></path><path d="M100.378 11.2483C100.221 11.1743 100.209 10.9646 100.366 10.8783C102.081 9.90401 102.987 8.25139 102.987 6.06845C102.987 4.24316 102.238 -0.0117188 95.2947 -0.0117188C90.0179 -0.0117188 86.9267 2.52888 86.6007 7.15375V7.78273H90.0179V7.17842C90.1266 4.93381 91.8292 3.24419 93.9785 3.24419H96.309C98.2772 3.24419 99.5934 4.57616 99.5934 6.56177C99.5934 8.54738 98.3738 9.85468 96.4056 9.85468H92.5416C92.4329 9.85468 92.3363 9.95334 92.3363 10.0643V12.6419C92.3363 12.7529 92.4329 12.8516 92.5416 12.8516H96.5867C98.8448 12.8516 100.258 14.3809 100.258 16.8475C100.258 19.3141 98.8085 20.7324 96.4901 20.7324H94.0268C91.7446 20.7324 90.0421 18.8331 89.873 16.1198V15.7375H86.4316V16.1445C86.7335 21.423 89.6315 23.9883 95.3068 23.9883C100.608 23.9883 103.651 21.3984 103.651 16.8845C103.651 14.1589 102.528 12.2226 100.378 11.236V11.2483Z" fill="#1477fb"></path><path d="M43.3235 13.3328C46.1129 12.4078 47.8396 10.0399 47.8396 7.10462C47.8396 3.26906 44.8812 0.494141 40.8119 0.494141H31.1881C31.0432 0.494141 30.9346 0.617471 30.9346 0.753133V10.4715C30.9346 10.6195 31.0553 10.7305 31.1881 10.7305H33.579C33.9896 10.7305 34.3277 11.0758 34.3277 11.4952V12.8518C34.3277 13.2711 33.9896 13.6164 33.579 13.6164H31.1881C31.0432 13.6164 30.9346 13.7398 30.9346 13.8754V23.2362C30.9346 23.3842 31.0553 23.4952 31.1881 23.4952H34.062C34.2069 23.4952 34.3156 23.3718 34.3156 23.2362V14.4674C34.3156 14.0481 34.6537 13.7028 35.0642 13.7028H39.5924C39.689 13.7028 39.7735 13.7521 39.8218 13.8384L44.9899 23.4088L45.0382 23.4828H48.383C48.5762 23.4828 48.6969 23.2732 48.6124 23.0882L43.3356 13.3081L43.3235 13.3328ZM34.3277 9.95354V3.79938C34.3277 3.65139 34.4484 3.54039 34.5812 3.54039H40.6308C42.913 3.54039 44.4345 4.97102 44.4345 7.10462C44.4345 9.23823 42.9009 10.7059 40.6308 10.7059H35.0642C34.6537 10.7059 34.3156 10.3605 34.3156 9.94121L34.3277 9.95354Z" fill="#1477fb"></path></g><defs><clipPath id="clip0_8747_12063"><rect width="103" height="24" fill="white" transform="translate(0.638672)"></rect></clipPath></defs></svg>
+    <img src="https://raw.githubusercontent.com/RSS3-Network/web3-icons/main/icons/rss3-alt-3.svg" alt="RSS3 Logo" width="200" />
 </p>
-<p align="center">
-  <a href="https://npmjs.com/package/@rss3/js-sdk"><img src="https://img.shields.io/npm/v/%40rss3%2Fjs-sdk?style=flat&logo=npm&color=%230072ff" alt="npm package"></a>
+
+# RSS3 JavaScript SDK
+
+<p>
+  <a href="https://npmjs.com/package/@rss3/api-core"><img src="https://img.shields.io/npm/v/%40rss3%2Fapi-core?style=flat&logo=npm&color=%230072ff" alt="npm package"></a>
+  <a href="https://bundlephobia.com/package/@rss3/api-core"><img alt="npm bundle size" src="https://img.shields.io/bundlephobia/minzip/%40rss3%2Fapi-core?style=flat&logo=npm&color=%230072ff"></a>
   <a href="https://twitter.com/intent/follow?screen_name=rss3_"><img src="https://img.shields.io/twitter/follow/rss3_?color=%230072ff" alt="follow RSS3 on X"></a>
   <a href="https://discord.gg/vfhpMjdbGU"><img src="https://img.shields.io/badge/chat-discord-blue?style=flat&logo=discord&color=%230072ff" alt="discord chat"></a>
 </p>
-<!-- markdownlint-enable -->
-
-# RSS3 JavaScript SDK
 
 > The Turbocharger for Your Next Open Web Development.
 
@@ -31,7 +31,7 @@ npm i @rss3/api-core
 Get open social activities of anyone, here we get `vitalik.eth`'s comments on `Farcaster`:
 
 ```js
-import { getActivities } from '@rss3/js-sdk'
+import { getActivities } from '@rss3/api-core'
 
 const socialActivities = await getActivities({
   account: "vitalik.eth",
@@ -44,7 +44,7 @@ const socialActivities = await getActivities({
 Or simply query cross-network and human-readable feed of anyone:
 
 ```js
-import { getActivities } from '@rss3/js-sdk'
+import { getActivities } from '@rss3/api-core'
 
 const readableFeed = await getActivities({
   account: "0xd8da6bf26964af9d7eed9e03e53415d37aa96045",

diff --git a/packages/api-core/README.md b/packages/api-core/README.md
@@ -1,16 +1,15 @@
-<!-- markdownlint-disable -->
 <p align="center">
-  <svg width="104" height="24" viewBox="0 0 104 24" fill="none" xmlns="http://www.w3.org/2000/svg"><g clip-path="url(#clip0_8747_12063)"><path d="M22.893 0.222656H1.36317C0.964698 0.222656 0.638672 0.543314 0.638672 0.962636V23.1867C0.638672 23.5937 0.964698 23.9267 1.36317 23.9267H22.893C23.2914 23.9267 23.6175 23.5937 23.6175 23.1867V0.962636C23.6175 0.555647 23.2914 0.222656 22.893 0.222656ZM20.5625 20.0541C20.4779 20.1898 20.333 20.2761 20.1761 20.2761H16.7709C16.6019 20.2761 16.4449 20.1774 16.3724 20.0171L14.4404 16.0459C14.3076 15.7869 14.042 15.6142 13.7522 15.6142H7.87161C7.75086 15.6142 7.65426 15.7129 7.65426 15.8362V19.8321C7.65426 20.0911 7.44899 20.2884 7.20749 20.2884H4.51476C4.26118 20.2884 4.06798 20.0788 4.06798 19.8321V12.4077C4.06798 12.1487 4.27326 11.9513 4.51476 11.9513H13.571C13.8971 11.9513 14.1748 11.68 14.1748 11.3347V8.17744C14.1748 7.84445 13.9091 7.56079 13.571 7.56079H4.51476C4.26118 7.56079 4.06798 7.35113 4.06798 7.10447V4.35421C4.06798 4.09522 4.27326 3.89789 4.51476 3.89789H13.9937C14.2472 3.89789 14.4404 4.10755 14.4404 4.35421V6.53715C14.4404 6.87014 14.7061 7.1538 15.0442 7.1538H17.3143C17.5679 7.1538 17.7611 7.36346 17.7611 7.61012V11.902C17.7611 12.161 17.5558 12.3583 17.3143 12.3583H15.0442C14.7182 12.3583 14.4404 12.6296 14.4404 12.975V14.5536C14.4404 14.9852 14.7785 15.3306 15.2012 15.3306H18.1958C18.3648 15.3306 18.5218 15.4292 18.5942 15.5896L20.5625 19.6225C20.6349 19.7704 20.6228 19.9308 20.5383 20.0664L20.5625 20.0541Z" fill="#1477fb"></path><path d="M60.6266 10.6434L55.8328 10.0021C54.6253 9.82939 53.2487 9.08941 52.8261 7.54779C52.2465 5.40185 53.9974 3.32991 56.1709 3.32991H58.7308C61.0854 3.32991 62.2688 5.57451 62.3654 7.64645V7.79445H65.8309V7.63412C65.6136 2.63926 62.6914 0 57.3784 0C52.3431 0 49.3485 2.55293 49.3485 6.82014C49.3485 10.372 51.4616 12.7646 54.9996 13.2456L59.8659 13.9239C61.665 14.1336 62.8242 15.4286 62.8242 17.2415C62.8242 19.2641 61.3994 20.6701 59.3587 20.6701H56.0985C53.5748 20.6701 52.4276 18.3762 52.2224 16.4029V16.2672H48.7568V16.4275C48.8655 21.4471 51.8601 23.9877 57.6682 23.9877C63.102 23.9877 66.2173 21.4347 66.2173 16.9825C66.2173 13.3936 64.237 11.1367 60.6387 10.6187L60.6266 10.6434Z" fill="#1477fb"></path><path d="M79.5485 10.6434L74.7547 10.0021C73.5472 9.82939 72.1706 9.08941 71.748 7.54779C71.1684 5.40185 72.9193 3.32991 75.0928 3.32991H77.6527C80.0073 3.32991 81.1907 5.57451 81.2873 7.64645V7.79445H84.7528V7.63412C84.5355 2.63926 81.6133 0 76.3003 0C71.265 0 68.2704 2.55293 68.2704 6.82014C68.2704 10.372 70.3835 12.7646 73.9215 13.2456L78.7877 13.9239C80.5869 14.1336 81.7461 15.4286 81.7461 17.2415C81.7461 19.2641 80.3213 20.6701 78.2806 20.6701H75.0203C72.4966 20.6701 71.3495 18.3762 71.1442 16.4029V16.2672H67.6787V16.4275C67.7874 21.4471 70.782 23.9877 76.5901 23.9877C82.0238 23.9877 85.1392 21.4347 85.1392 16.9825C85.1392 13.3936 83.1589 11.1367 79.5605 10.6187L79.5485 10.6434Z" fill="#1477fb"></path><path d="M100.378 11.2483C100.221 11.1743 100.209 10.9646 100.366 10.8783C102.081 9.90401 102.987 8.25139 102.987 6.06845C102.987 4.24316 102.238 -0.0117188 95.2947 -0.0117188C90.0179 -0.0117188 86.9267 2.52888 86.6007 7.15375V7.78273H90.0179V7.17842C90.1266 4.93381 91.8292 3.24419 93.9785 3.24419H96.309C98.2772 3.24419 99.5934 4.57616 99.5934 6.56177C99.5934 8.54738 98.3738 9.85468 96.4056 9.85468H92.5416C92.4329 9.85468 92.3363 9.95334 92.3363 10.0643V12.6419C92.3363 12.7529 92.4329 12.8516 92.5416 12.8516H96.5867C98.8448 12.8516 100.258 14.3809 100.258 16.8475C100.258 19.3141 98.8085 20.7324 96.4901 20.7324H94.0268C91.7446 20.7324 90.0421 18.8331 89.873 16.1198V15.7375H86.4316V16.1445C86.7335 21.423 89.6315 23.9883 95.3068 23.9883C100.608 23.9883 103.651 21.3984 103.651 16.8845C103.651 14.1589 102.528 12.2226 100.378 11.236V11.2483Z" fill="#1477fb"></path><path d="M43.3235 13.3328C46.1129 12.4078 47.8396 10.0399 47.8396 7.10462C47.8396 3.26906 44.8812 0.494141 40.8119 0.494141H31.1881C31.0432 0.494141 30.9346 0.617471 30.9346 0.753133V10.4715C30.9346 10.6195 31.0553 10.7305 31.1881 10.7305H33.579C33.9896 10.7305 34.3277 11.0758 34.3277 11.4952V12.8518C34.3277 13.2711 33.9896 13.6164 33.579 13.6164H31.1881C31.0432 13.6164 30.9346 13.7398 30.9346 13.8754V23.2362C30.9346 23.3842 31.0553 23.4952 31.1881 23.4952H34.062C34.2069 23.4952 34.3156 23.3718 34.3156 23.2362V14.4674C34.3156 14.0481 34.6537 13.7028 35.0642 13.7028H39.5924C39.689 13.7028 39.7735 13.7521 39.8218 13.8384L44.9899 23.4088L45.0382 23.4828H48.383C48.5762 23.4828 48.6969 23.2732 48.6124 23.0882L43.3356 13.3081L43.3235 13.3328ZM34.3277 9.95354V3.79938C34.3277 3.65139 34.4484 3.54039 34.5812 3.54039H40.6308C42.913 3.54039 44.4345 4.97102 44.4345 7.10462C44.4345 9.23823 42.9009 10.7059 40.6308 10.7059H35.0642C34.6537 10.7059 34.3156 10.3605 34.3156 9.94121L34.3277 9.95354Z" fill="#1477fb"></path></g><defs><clipPath id="clip0_8747_12063"><rect width="103" height="24" fill="white" transform="translate(0.638672)"></rect></clipPath></defs></svg>
+    <img src="https://raw.githubusercontent.com/RSS3-Network/web3-icons/main/icons/rss3-alt-3.svg" alt="RSS3 Logo" width="200" />
 </p>
-<p align="center">
-  <a href="https://npmjs.com/package/@rss3/js-sdk"><img src="https://img.shields.io/npm/v/%40rss3%2Fjs-sdk?style=flat&logo=npm&color=%230072ff" alt="npm package"></a>
+
+# RSS3 JavaScript SDK
+
+<p>
+  <a href="https://npmjs.com/package/@rss3/api-core"><img src="https://img.shields.io/npm/v/%40rss3%2Fapi-core?style=flat&logo=npm&color=%230072ff" alt="npm package"></a>
   <a href="https://bundlephobia.com/package/@rss3/api-core"><img alt="npm bundle size" src="https://img.shields.io/bundlephobia/minzip/%40rss3%2Fapi-core?style=flat&logo=npm&color=%230072ff"></a>
   <a href="https://twitter.com/intent/follow?screen_name=rss3_"><img src="https://img.shields.io/twitter/follow/rss3_?color=%230072ff" alt="follow RSS3 on X"></a>
   <a href="https://discord.gg/vfhpMjdbGU"><img src="https://img.shields.io/badge/chat-discord-blue?style=flat&logo=discord&color=%230072ff" alt="discord chat"></a>
 </p>
-<!-- markdownlint-enable -->
-
-# RSS3 API Core
 
 > The Turbocharger for Your Next Open Web Development.