diff --git a/README.md b/README.md index 8b09475..ac6622a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,42 @@ -# woomy-next -Rewrite of Woomy's codebase, because I'm getting really sick of working on shitty two year-old code. If you aren't a developer, please switch back to the master branch! -# notes for devs -- please install ESLint and use the included .eslintrc.js file to have properly formatted code when you're writing Woomy \ No newline at end of file +Woomy +================ + +shields go here + +### A feature-rich and configurable Discord bot for music, moderation, currency and more! + +**Links** +* [Official bot invite](https://discordapp.com/oauth2/authorize?client_id=435961704145485835&permissions=2134240503&scope=bot) +* [For updates and support join my Discord server!](https://discord.gg/HCF8mdv) + +# Getting Started + +# Contributors + +Thanks to the following people who have contributed to Woomy: + +* [@mudkipscience](https://github.com/mudkipscience/) - Creator and primary developer of Womy +* [@FLGX](https://github.com/FLGX06/) - Developer, basically wrote the entirety of the music commands and lots of other cool stuff +* [@TheCakeChicken](https://github.com/TheCakeChicken/) - Developer + +And a few other people as well. Check out the [Contributors](https://github.com/mudkipscience/woomy/graphs/contributors) tab! + +# Legal stuff + +## Using our code +If you wish to use our code in your project, please credit us! We don't mind you using Woomy's code (it is open source for a reason :P) as long as you dont blatantly copy it and/or refrain from crediting us. + +## License + +Copyright (C) 2018-2020 **Emily J. / mudkipscience** + +>This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License +>as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +> +>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; +>without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +> +>See the GNU Affero General Public License for more details. +>You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/ + +The full license can be found in the root of this repository.