From 22b3dae262dd89cba0164b0b9329b979d0a1608b Mon Sep 17 00:00:00 2001 From: sarthakjdev Date: Tue, 4 Jun 2024 01:45:28 +0530 Subject: [PATCH] fix: library to SDK Signed-off-by: sarthakjdev --- README.md | 12 ++++++------ package.json | 5 +++-- packages/example-chat-bot/package.json | 2 +- packages/example-chat-bot/src/index.ts | 2 +- packages/wapi.js/README.md | 12 ++++++------ packages/wapi.js/package.json | 2 +- 6 files changed, 18 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 3fdba49..cfe3d33 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ ## 📌 Status -Beta Version - This library is not stable right now. It is currently in beta version. Report issues [here](https://github.com/sarthakjdev/wapi.js/issues). +Beta Version - This SDK is not stable right now. It is currently in beta version. Report issues [here](https://github.com/sarthakjdev/wapi.js/issues). ## 📖 About @@ -35,7 +35,7 @@ Wapi.js is a JavaScript module, written in TypeScript, designed to interact with ## 💻 Installation -Ensure you have the Node.js 18 LTS version to use this library. +Ensure you have the Node.js 18 LTS version to use this SDK. ```sh npm install @wapijs/wapi.js @@ -43,7 +43,7 @@ yarn add @wapijs/wapi.js pnpm install @wapijs/wapi.js ``` -> Note: This library is not affiliated with the official WhatsApp Cloud API or does not act as any official solution provided the the Meta Inclusive Private Limited, this is just a open source library built for developers to support them in building whatsapp cloud api based chat bots easily. +> Note: This SDK is not affiliated with the official WhatsApp Cloud API or does not act as any official solution provided the the Meta Inclusive Private Limited, this is just a open source SDK built for developers to support them in building whatsapp cloud api based chat bots easily. ## 🚀 Usage @@ -81,7 +81,7 @@ import { Client, TextMessage } from 'wapi.js' }) await whatsappClient.message.send({ - message: new TextMessage({ text: 'hiii, this is wapijs library' }), + message: new TextMessage({ text: 'hiii, this is wapijs SDK' }), phoneNumber: 'XXXXXXXXXX' }) @@ -91,7 +91,7 @@ import { Client, TextMessage } from 'wapi.js' whatsappClient.on('TextMessage', async (message) => { message.reply({ - message: new TextMessage({ text: 'hiii, this is wapijs library' }),, + message: new TextMessage({ text: 'hiii, this is wapijs SDK' }),, }) }) @@ -124,4 +124,4 @@ Distributed under the Apache 2.0 License. View [LICENSE](./LICENSE). - Email: sarthak@softlancer.co - [Twitter](https://twitter.com/sarthakjdev) | [LinkedIn](https://www.linkedin.com/in/sarthakjdev) -Note: This library is part of an open-source product-building initiative by [Softlancer](https://github.com/softlancerhq), and this repository will soon be moved under the same organization. +Note: This SDK is part of an open-source product-building initiative by [Softlancer](https://github.com/softlancerhq), and this repository will soon be moved under the same organization. diff --git a/package.json b/package.json index fe0fb61..12ccef2 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "wapijs", "version": "0.0.1", - "description": "wapi.js is a node library built for developing whatsapp cloud API based app in a user friendly way.", + "description": "wapi.js is a node SDK built for developing whatsapp cloud API based app in a user friendly way.", "private": true, "scripts": { "watch": "turbo watch --concurrency=3", @@ -25,7 +25,8 @@ "nodejs", "@wapijs/wapi.js", "wapi.js", - "wapi.js library" + "wapi.js SDK", + "software-development-kit" ], "authors": [ "sarthak@softlancer.co" diff --git a/packages/example-chat-bot/package.json b/packages/example-chat-bot/package.json index 0973b49..8d686c4 100644 --- a/packages/example-chat-bot/package.json +++ b/packages/example-chat-bot/package.json @@ -19,7 +19,7 @@ "typescript", "nodejs", "@wapijs/wapi.js", - "wapi.js library" + "wapi.js SDK" ], "authors": [ "sarthak@softlancer.co" diff --git a/packages/example-chat-bot/src/index.ts b/packages/example-chat-bot/src/index.ts index 1109c12..361a7d4 100644 --- a/packages/example-chat-bot/src/index.ts +++ b/packages/example-chat-bot/src/index.ts @@ -10,7 +10,7 @@ function init() { 'What is wapijs': [ { question: 'What is wapi.js?', - answer: 'wapi.js is a Tyepscript library for building WhatsApp chatbots.' + answer: 'wapi.js is a Tyepscript SDK for building WhatsApp chatbots.' }, { question: 'Main features of wapi.js?', diff --git a/packages/wapi.js/README.md b/packages/wapi.js/README.md index db2dc07..f17a397 100644 --- a/packages/wapi.js/README.md +++ b/packages/wapi.js/README.md @@ -13,7 +13,7 @@ ## 📌 Status -Beta Version - This library is not stable right now. It is currently in beta version. Report issues [here](https://github.com/sarthakjdev/wapi.js/issues). +Beta Version - This SDK is not stable right now. It is currently in beta version. Report issues [here](https://github.com/sarthakjdev/wapi.js/issues). ## 📖 About @@ -30,7 +30,7 @@ Wapi.js is a JavaScript module, written in TypeScript, designed to interact with ## 💻 Installation -Ensure you have the Node.js 18 LTS version to use this library. +Ensure you have the Node.js 18 LTS version to use this SDK. ```sh npm install @wapijs/wapi.js @@ -38,7 +38,7 @@ yarn add @wapijs/wapi.js pnpm install @wapijs/wapi.js ``` -> Note: This library is not affiliated with the official WhatsApp Cloud API or does not act as any official solution provided the the Meta Inclusive Private Limited, this is just a open source library built for developers to support them in building whatsapp cloud api based chat bots easily. +> Note: This SDK is not affiliated with the official WhatsApp Cloud API or does not act as any official solution provided the the Meta Inclusive Private Limited, this is just a open source SDK built for developers to support them in building whatsapp cloud api based chat bots easily. ## 🚀 Usage @@ -76,7 +76,7 @@ import { Client, TextMessage } from 'wapi.js' }) await whatsappClient.message.send({ - message: new TextMessage({ text: 'hiii, this is wapijs library' }), + message: new TextMessage({ text: 'hiii, this is wapijs SDK' }), phoneNumber: 'XXXXXXXXXX' }) @@ -86,7 +86,7 @@ import { Client, TextMessage } from 'wapi.js' whatsappClient.on('TextMessage', async (message) => { message.reply({ - message: new TextMessage({ text: 'hiii, this is wapijs library' }),, + message: new TextMessage({ text: 'hiii, this is wapijs SDK' }),, }) }) @@ -113,4 +113,4 @@ Distributed under the Apache 2.0 License. View [LICENSE](./LICENSE). - Email: sarthak@softlancer.co - [Twitter](https://twitter.com/sarthakjdev) | [LinkedIn](https://www.linkedin.com/in/sarthakjdev) -Note: This library is part of an open-source product-building initiative by [Softlancer](https://github.com/softlancerhq), and this repository will soon be moved under the same organization. +Note: This SDK is part of an open-source product-building initiative by [Softlancer](https://github.com/softlancerhq), and this repository will soon be moved under the same organization. diff --git a/packages/wapi.js/package.json b/packages/wapi.js/package.json index ecb1ab8..e1dba28 100644 --- a/packages/wapi.js/package.json +++ b/packages/wapi.js/package.json @@ -1,7 +1,7 @@ { "name": "@wapijs/wapi.js", "version": "0.0.8", - "description": "a typescript based client library to build whatsapp cloud api based chat bots", + "description": "a typescript based client SDK to build whatsapp cloud api based chat bots", "main": "dist/cjs/index.js", "module": "dist/esm/index.js", "types": "dist/cjs/index.js",