diff --git a/.github/README.md b/.github/README.md index 52d5743..3a940e8 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,32 +1,29 @@ -### `Read this page before asking any questions` -> **[Important Guides](https://github.com/OSL-Works/Discord-Channel-Moderator#important-links)**
+*Read this page before asking any questions* +> **[Important Links](#important-links)**

- +

-

- About - -

+

About

-An free open source, discord moderation bot that helps you restrict certain things such as commands, links or filter words in channels where they were not allowed. -


+ An free open source, discord moderation bot that helps you restrict certain things such as commands, links or filter words in channels where they were not allowed.

+---

GitHub package version - GitHub forks + GitHub forks - GitHub stars + GitHub stars - GitHub license + GitHub license Support @@ -42,8 +39,6 @@ An free open source, discord moderation bot that helps you restrict certain thin

- -

@@ -55,86 +50,71 @@ An free open source, discord moderation bot that helps you restrict certain thin - This project will receive constant updates and new features added ! - Make sure to leave an star on the projects repo! -# Note: +## Note: -


+To everyone who plan to sell our project by stating that they coded it or that they sell edited version: -**To everyone who plan to sell our project by stating that they coded it or that they sell edited version.**
-**Project is licensed under the MIT license**
+**Project is licensed under the MIT license** -### "`The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.`"
+> `The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.` -
+This means that if you plan to sell our project to make quick buck please keep the copyright notice and copy of original license. -This means that if you plan to sell our project to make quick buck please keep the copyright notice and copy of original license.
**In case of breaking licensing terms we may take legal charges against you.** -Project is made open source and **free for all.**
-**We cant prohibit reselling of our project but if you do please follow the licensing terms.**
+Project is made open source and **free for all.** -
-
+**We cant prohibit reselling of our project but if you do please follow the licensing terms.** -# Important Links +## Important Links -
- -### `Setup Guide` +### Setup Guide > **[Step By Step Setup Guide](https://github.com/OSL-Works/Discord-Channel-Moderator/wiki)**(currenty writing)
-### `Troubleshooting Guide` +### Troubleshooting Guide > **[List of common user made errors and how to solve them](https://refloow.com/Open-Source-Projects/troubleshooting)**
-### `Contributions` +### Contributions > **[Want to contribute? Read how](https://github.com/OSL-Works/Discord-Channel-Moderator/blob/master/.github/CONTRIBUTING.md)**
-### `Features` +### Features > **[See list of features](https://github.com/OSL-Works/Discord-Channel-Moderator/blob/master/.github/FEATURES.md)**
> **[See version changelogs](https://github.com/OSL-Works/Discord-Channel-Moderator/blob/master/.github/changelog.md)**
-### `FAQ` -> **[Frequently Asked Questions]()**(currenty writing)
- -
+### FAQ +> **[Frequently Asked Questions]()** (currenty writing) -# DISCORD Support Server +## Discord Support Server **https://discord.gg/XxvjjPs** -
- -# Support the project +## Support the project - **If you like the project and the fact that is free you can support us by giving an donation.** - We are accepting donations: 1. Crypto: https://refloow.com/cdonate 2. Steam: https://steamcommunity.com/tradeoffer/new/?partner=994828078&token=XEUdbqp6 -
+## Want Improvements ? -# Want Improvements ? +If you have some private requests feel free to contact main dev : https://steamcommunity.com/id/MajokingGames/ or mail at refloowlibrarycontact@gmail.com -If you have some private requests feel free to contact main dev : https://steamcommunity.com/id/MajokingGames/
-Or mail at refloowlibrarycontact@gmail.com
**Note that we wont add any platform breaking TOS Modifications to any of our existing or requested projects** -
- -# How to setup bot ? +## How to setup the bot ? - Setup bots profile at https://discordapp.com/developers/applications - Enter bots token in configuration (Discord-Channel-Moderator/Settings/config.js) - Finish configuration how you like - Invite bot to your server -- How bot operate: +## How the bot operate + +- To prevent other bots responding on commands in wrong channel add them to roles/members in channel where you want to restrict them and disable Text Premission - Send Messages & Read Messages +- Add your bot that you host script on and set his TEXT PREMISSIONS - Read Messages & Manage Messages to true in channel you want bot to operate (Number of channels is not limited) +- In the channels where you want commands to take place set bots TEXT PREMISSIONS - Read Messages & Manage Messages to false + +*Check images in (Discord-Channel-Moderator/Settings/Server Setup Images) for visual guide* - - To prevent other bots responding on commands in wrong channel add them to roles/members in channel where you want to restrict them and disable Text Premission - Send Messages & Read Messages - - Add your bot that you host script on and set his TEXT PREMISSIONS - Read Messages & Manage Messages to true in channel you want bot to operate (Number of channels is not limited) - - In the channels where you want commands to take place set bots TEXT PREMISSIONS - Read Messages & Manage Messages to false - - Check images in (Discord-Channel-Moderator/Settings/Server Setup Images) for visual guide - - -## Stars over time +## Stargazers over time [![Stargazers over time](https://starchart.cc/Refloow/Discord-Channel-Moderator.svg)](https://starchart.cc/Refloow/Discord-Channel-Moderator)