Skip to content

Commit

Permalink
docs: refining some words
Browse files Browse the repository at this point in the history
  • Loading branch information
gensart-ai committed Mar 19, 2024
1 parent b6ebd83 commit 9b8f382
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 16 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<p align="center">
<img width="250" height="250" src="https://i.ibb.co/7y1v1q4/hour.png">
</p>

# SoraErlyana

![forthebadge](https://img.shields.io/github/last-commit/gensart-ai/whatsapp-bot/main?display_timestamp=author&style=for-the-badge&logo=github&link=https%3A%2F%2Fgithub.com%2Fgensart-ai%2Fwhatsapp-bot)
Expand All @@ -12,11 +13,13 @@ WhatsApp bot powered by Node.js, with several daily commands that might be usefu

# Preview

![preview of the bot](https://i.ibb.co/0f7r1jj/0229.gif)
The preview might take a while to load sometimes, depends on your connection.

![preview of the bot](https://i.ibb.co/BKDnYQD/whatsapp-bot-preview.gif)

# Technology Used <!-- {docsify-ignore} -->

> This project still on development 🚧, so it might have a massive changes, so stay tuned !
> This project still on maintaining 🚧, so it might have a massive changes, so stay tuned !
![forthebadge](https://img.shields.io/badge/Node.js-100000?style=for-the-badge&logo=node.js&logoColor=white&labelColor=60AA50&color=447C42)
![forthebadge](https://img.shields.io/badge/Typescript-100000?style=for-the-badge&logo=typescript&logoColor=white&labelColor=5094DD&color=5094DD)
Expand Down
18 changes: 11 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,25 @@
<img width="300" height="300" src="https://i.ibb.co/7y1v1q4/hour.png">

> This project still on development 🚧, so it might have a massive changes, stay tuned !
> This project is still maintained, so it might have a massive changes, stay tuned !
#### WhatsApp bot powered by Node.js, with several daily commands that might be useful for you !

[![forthebadge](https://forthebadge.com/images/badges/made-with-javascript.png)](https://nodejs.org)
[![forthebadge](https://forthebadge.com/images/badges/powered-by-electricity.png)](https://web.pln.co.id/tentang-kami/profil-perusahaan)
[![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](http://forthebadge.com)

# Technology Used <!-- {docsify-ignore} -->
<a href='https://nodejs.org' target="_blank"><img alt='node.js' src='https://img.shields.io/badge/Node.js-100000?style=for-the-badge&logo=node.js&logoColor=white&labelColor=60AA50&color=447C42'/></a> <a href='https://www.typescriptlang.org/' target="_blank"><img alt='typescript' src='https://img.shields.io/badge/Typescript-100000?style=for-the-badge&logo=typescript&logoColor=white&labelColor=5094DD&color=5094DD'/></a>
# Technology Used

- NodeJS
- TypeScript
- whatsapp-web.js
- Debian

# Overview
!> This application uses `whatsapp-web.js` as a primary library. Keep in mind if you want to use this app, you did already know that **WhatsApp terms & conditions do not allow any bots or automation** on its services. So, I do not responsible for any banning happen to your WhatsApp account by using this app. <b>I strongly suggested</b> you to use this app with your WhatsApp backup number. I use my second number for this and still safe until now.

!> This application uses `whatsapp-web.js` as a primary library. Keep in mind if you want to use this app, you did already know that **WhatsApp terms & conditions do not allow any bots or automation** on its services. So, I do not responsible for any banning happen to your WhatsApp account by using this app. **I strongly suggest** you to use this app with your WhatsApp backup number. I use my second number for this and still safe until now.

Current Stable Version : `1.1.0`
Look at the sidebar for more docs.
(Can't see the sidebar on mobile ? The button is on your bottom left screen :))
Look at the sidebar for more docs.

And it's done.
# Can't see the sidebar on mobile ? The button is on your bottom left screen
20 changes: 14 additions & 6 deletions docs/REQUIREMENTS.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,28 @@
# Requirements
# Requirements

## TL;DR <!-- {docsify-ignore} -->

## TL;DR <!-- {docsify-ignore} -->
You need :

- Node.js v18++
- NPM installed on your device
- [ffmpeg](https://ffmpeg.org/) (Windows users may need this) - For multimedia support
- ImgBB API Key, learn more at [https://api.imgbb.com/](https://api.imgbb.com/). Its usage is for Image-To-Sticker Text module
- Ghola API, learn more at [https://www.ghola.ai/developer](https://www.ghola.ai/developer). You may need to signup/login using Google account first. Its usage is for AI Text Generation

## Long to short <!-- {docsify-ignore} -->

This project requires **Node.js** to run, I use **Node v20.10** on Windows 10 and **Debian 11** too and it works fine. I haven't tested it yet on different version or environment than mine, but you may try it and report it to me, so I can update this details by you :).
You can use this [link](https://nodejs.org/en) to go to Node.js homepage for installation or more details.
You can use this [link](https://nodejs.org/en) to go to Node.js homepage for installation or more details.

Oh also, make sure you have installed **NPM** too. Usually **Node.js** includes **NPM** so you don't need to install it again.
Oh also, make sure you have installed **NPM** too. Usually **Node.js** includes **NPM** so you don't need to install it again.

And i often experience errors when testing multimedia with this app on Windows 10 environment, but not on Debian 11. My assumption going to **ffmpeg** problem, maybe you can install that if you experience an error when dealing with multimedia thing.

## **🔴 IMPORTANT NOTICE 🔴** <!-- {docsify-ignore} -->
This project greatly having use of [whatsapp-web.js](https://wwebjs.dev/), and maybe **if you are running on a `no-gui` Linux image (Server, or Linux OS that did not installed GUI system)**, you may need to see and follow this page first : [Click Me](https://wwebjs.dev/guide/#installation-on-no-gui-systems)
You also need ImgBB for multimedia thing in current built-in features. Soon maybe I'll explain more why I use this, and maybe doing removal on need of ImgBB if possible. See [here](https://api.imgbb.com/) for more information.

Ghola API key is needed for built-in feature : AI with `.tanya` command. It hits Ghola's AI API. See [here](https://www.ghola.ai/developer) for more information.

## **🔴 IMPORTANT NOTICE 🔴** <!-- {docsify-ignore} -->

This project greatly having use of [whatsapp-web.js](https://wwebjs.dev/), and maybe **if you are running on a `no-gui` Linux image (Server, or Linux OS that did not installed GUI system)**, you may need to see and follow this page first : [Click Me](https://wwebjs.dev/guide/#installation-on-no-gui-systems)
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<div id="app"></div>
<script>
window.$docsify = {
name: "gensart-ai/whatsapp-bot",
name: "SoraErlyana Documentation",
loadSidebar: true,
loadNavbar: true,
subMaxLevel: 2,
Expand Down

0 comments on commit 9b8f382

Please sign in to comment.