Updated README.md

This commit is contained in:
Toastie 2023-11-26 22:41:03 +13:00
parent 45fe6df464
commit 14f7ba48e8
No known key found for this signature in database
GPG key ID: FF47E5D4A3C8DC5E

View file

@ -1,38 +1,46 @@
# Giveaway-Child
# Holana
## Updates
- Update discord.js version to v13.
- Format the code looks more cleaner.
- Minor bot fixes and improvements.
## Requirements
- Nodejs v16
- Invite your bot with bot and applications scope
- Bot needs v16 of nodejs to work
- Invite your bot with `bot` and `applications.commands` scope
- Bot only uses slash commands, message content no longer exists.
- Bot currently supports v14 of discord.js.
## Features
- Fast giveaways created using the best databases, like: mongodb, quick.db, .etc
- LAST CHANCE TO ENTER warning when a giveaway is about to end.
- Slash commands for faster giveaway creating.
Drop giveaway ability, drop giveaways anytime in your server with the drop command.
- Pause and un-pause giveaway feature.
- Lightning fast giveaways created using best databases, like: mongodb, quick.db, etc.
- LAST CHANCE TO ENTER warning when giveaway is about to end.
- Slash commands for faster and simpler giveaway creating.
- Drop giveaway ability, drop giveaway anytime in your server with drop command.
- Pause and un-pause giveaways.
## Links
- 🔗 [Invite Link](https://discord.com/api/oauth2/authorize?client_id=726333575091454002&permissions=8&scope=bot)
- [Support Server Link](https://discord.gg/SVQVzJq)
- 📑 [Commands](https://docs.elliebot.net/Giveaway-Child/Commands/)
- 🌐 [Website](https://docs.elliebot.net/coming_soon)
## Custom/External Database setup
- Read the [README](Database%20Examples/README.md) file and you are good to go to use custom db's.
- [Support Server Link](https://discord.gg/etQdZxSyEH)
- 📑 [Commands](https://docs.elliebot.net/Giveaway-child/Commands)
- 🌐 [Website](https://docs.elliebot.net/category/holana)
## Setup
- `npm i`
- Pick a database from the Database Examples folder.
- Just copy and paste it into the [index file](index.js)
- Fill out the [config file](config.example.json) and save it as config.js.
- Then run the bot with `npm run start`
## Custom/External Database setup
- Check the example folder to get the custom database examples
## Manual setup on local machine
- Run command `npm i`
- Pick a database from `Database Examples` folder and copy it to `index.js` file.
- Fill the configurations.
- Run command `npm run start`
## Credits
**Thanks to [Androz](https://github.com/Androz2091) for his package which make this bot possible [discord-giveaways](https://www.npmjs.com/package/discord-giveaways) give him a star for his work.**
**Thanks to [Androz](https://github.com/Androz2091) for his package which make this bot possible [discord-giveaways](https://www.npmjs.com/package/discord-giveaways) give him a star for his work.**