@delirius/welcard/README.md

WelCard is a lightweight and futuristic welcome card library designed for WhatsApp Bots.

<p align="center">
    <img width="400" alt="typescript-starter dark logo" src="https://i.imgur.com/7IDC9Qe.png" style="max-width:100%;">

<h2 align="center">
    **@delirius/welcard** is a lightweight and futuristic welcome card libary designed for WhatsApp & Discords Bots.
</h2>

<p align="center">
  <a href="https://www.npmjs.com/package/@delirius/welcard">
    <img src="https://img.shields.io/npm/v/@delirius/welcard.svg" alt="version" />
  </a>
  <a href="https://npmjs.org/package/@delirius/welcard/">
    <img src="https://img.shields.io/npm/dm/@delirius/welcard.svg" alt="downloads" />
  </a>
   <a href="https://packagephobia.now.sh/result?p=@delirius/welcard">
    <img src="https://packagephobia.now.sh/badge?p=@delirius/welcard" alt="install size" />
  </a>
</p>


# Installation
```
npm i @delirius/welcard
```

# Usage with Baileys (WhatsApp Bot)
```js
// ES6
import { WelCard } from "@delirius/welcard";

// CommonJS
const { WelCard } = require("@delirius/welcard");

const card = new WelCard()
  .setName("Welcome")
  .setAuthor('Participants')
  .setServer('Group Name')
  .setColor("auto")
  .setBrightness(50)
  .setThumbnail("https://i.postimg.cc/3rLKbgLH/image.jpg");
const cardBuffer = await card.build();

sock.sendMessage(jid, { image: cardBuffer }); // sending the image]
```

# Standalone Usage

```javascript

// ES6
import { WelCard } from "@delirius/welcard";
import fs from "fs";

// CommonJS
const { WelCard } = require("@delirius/welcard");
const fs = require("fs");

(async () => {
  const card = new WelCard()
    .setName("Welcome")
    .setAuthor("Participants")
    .setServer("Group Name 🪐")
    .setColor("auto")
    .setBrightness(50)
    .setThumbnail("https://i.postimg.cc/3rLKbgLH/image.jpg");

  const cardBuffer = await card.build();

  fs.writeFileSync("card.png", cardBuffer);
  console.log("Listo");
})();
```

# Support and Updates
This project will receive updates and more details will be implemented.