diff --git a/README.md b/README.md index 9311fcf8..fde7be99 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -# Hey there! Welcome to my official GitHub repository! +# Hey there! Welcome to my official GitHub repository +

I'm zuly, just a simple bot to discord!
Hi! I'm zuly, a 100% Brazilian bot focused on anime for otakus!
@@ -12,65 +13,95 @@ Hi! I'm zuly, a 100% Brazilian bot focused on anime for otakus!

### 💻 Self-Hosting -> __**We are not responsible for any mistakes made by you.**__ -- Install nodejs 14 or higher. You can download and install here: https://nodejs.org -- Rename **all** name.example.js files to name.js + +> ____We are not responsible for any mistakes made by you.____ + +- Install nodejs 14 or higher. You can download and install here: +- Rename __all__ name.example.js files to name.js + > ⚙️ config.js + ```js // config.js module.exports = { - token: 'you discord bot token', - client: { - id: 'you discord bot id', - secret: 'you discord bot secret' - }, + token: 'you discord bot token', + client: { + id: 'you discord bot id', + secret: 'you discord bot secret' + }, deployslash: true, // set this to true if you want to create slash-commands and false if you just want to update. - deploy: 'yes', // if this is how it is, it won't do any updates to slash-commands - mongodb: 'you mongodb url https://mongodb.com/', - prefix: ['bot-prefixes', 'bot-prefixes'] + deploy: 'yes', // if this is how it is, it won't do any updates to slash-commands + mongodb: 'you mongodb url https://mongodb.com/', + prefix: ['bot-prefixes', 'bot-prefixes'] }; ``` + > 🎵 nodes.json + ```js // nodes.js module.exports = [{ - name: 'node-name', // can be anyone - host: 'localhost', // your lavalink ip, or if it is with your bot, localhost - port: 2333, // your lavalink port, by default 2333 - password: 'youshallnotpass' // lavalink password, by default youshallnotpass + name: 'node-name', // can be anyone + host: 'localhost', // your lavalink ip, or if it is with your bot, localhost + port: 2333, // your lavalink port, by default 2333 + password: 'youshallnotpass' // lavalink password, by default youshallnotpass }] ``` -### ⬆️ Starting: + +### ⬆️ Starting + - Install the packages: + ```bash yarn ``` + - Start the bot: + ``` yarn start ``` + > And done, your own version of zuly online! -### 🥳 Contributing: + +### 🥳 Contributing + Ah! So you would like to contribute to my repository, right? Great! We love new contributors who help us! + - Fork this repository and make your desired changes - Once they're done, make a pull request to the master branch if you are contributing to the new version or the master branch if you are contributing to the stable and running version -### 🌎 Translating: + +### 🌎 Translating + Of course we do not support only English. We're looking to expand to a variety of new languages and for such thing we need your help! We are now working with Crowdin. Please check out our [Crowdin](https://crowdin.com/project/zuly) repo! -### ⛔ Issues: + +### ⛔ Issues + If you have any problems, pleas open a [Issue](https://github.com/zulybot/zuly/issues) or [contact us](https://zulybot.xyz/discord) -### 👋 Thanks for using my functions! + +### 👋 Thanks for using my functions + ![ZulyBot](/assets/readme/banner.jpeg) -### 🤝 Partners: + +### 🤝 Partners + - Thanks [www.openode.io](https://www.openode.io) for the hosting! -### 🔗 Links: + +### 🔗 Links + > Official Website: + - [Zulybot.xyz](https://zulybot.xyz/) + > Botlists: + - [Discord.Bots](https://discord.bots.gg/bots/880173509077266483) - [Top.gg](https://top.gg/bot/880173509077266483) - [Bestlist.Online](https://bestlist.online/bots/880173509077266483) - [Bluephoenixlist.xyz](https://bluephoenixlist.xyz/bot/880173509077266483) -### 🐦 Github Status: + +### 🐦 Github Status +

Node Version Issues

✨ Stargazers:

diff --git a/SECURITY.md b/SECURITY.md index f5b15e2a..4e0d7f3e 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -17,6 +17,7 @@ Use this section to tell people how to report a vulnerability. Tell them where to go, how often they can expect to get an update on a reported vulnerability, what to expect if the vulnerability is accepted or declined, etc. + # Security Policy ## Supported Versions