Skip to content

Commit

Permalink
fix: library to SDK
Browse files Browse the repository at this point in the history
Signed-off-by: sarthakjdev <[email protected]>
  • Loading branch information
sarthakjdev committed Jun 3, 2024
1 parent 234c784 commit 22b3dae
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 17 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -35,15 +35,15 @@ 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
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

Expand Down Expand Up @@ -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'
})

Expand All @@ -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' }),,
})
})

Expand Down Expand Up @@ -124,4 +124,4 @@ Distributed under the Apache 2.0 License. View [LICENSE](./LICENSE).
- Email: [email protected]
- [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.
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -25,7 +25,8 @@
"nodejs",
"@wapijs/wapi.js",
"wapi.js",
"wapi.js library"
"wapi.js SDK",
"software-development-kit"
],
"authors": [
"[email protected]"
Expand Down
2 changes: 1 addition & 1 deletion packages/example-chat-bot/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"typescript",
"nodejs",
"@wapijs/wapi.js",
"wapi.js library"
"wapi.js SDK"
],
"authors": [
"[email protected]"
Expand Down
2 changes: 1 addition & 1 deletion packages/example-chat-bot/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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?',
Expand Down
12 changes: 6 additions & 6 deletions packages/wapi.js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -30,15 +30,15 @@ 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
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

Expand Down Expand Up @@ -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'
})

Expand All @@ -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' }),,
})
})

Expand All @@ -113,4 +113,4 @@ Distributed under the Apache 2.0 License. View [LICENSE](./LICENSE).
- Email: [email protected]
- [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.
2 changes: 1 addition & 1 deletion packages/wapi.js/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit 22b3dae

Please sign in to comment.