From f9d4b620d4948a9cade1619127b21cb7d8a7a65c Mon Sep 17 00:00:00 2001 From: LucasCtrl Date: Fri, 2 Oct 2020 18:08:39 +0200 Subject: [PATCH] :zap: Improve README.md --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 41 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0319a31..4081d21 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,41 @@ -# spookyBot -🎃 A spooky Discord bot +# SpookyBot +🎃 *A spooky Discord bot* + +[![release](https://img.shields.io/github/release/LucasCtrl/spookyBot.svg?style=flat-square&logo=github&logoColor=fafafa&colorA=191b25&colorB=32cb8b)](https://github.com/LucasCtrl/spookyBot/releases/latest) +[![issues](https://img.shields.io/github/issues/LucasCtrl/spookyBot.svg?style=flat-square&colorA=191b25)](https://github.com/LucasCtrl/spookyBot/issues) +[![stars](https://img.shields.io/github/stars/LucasCtrl/spookyBot.svg?style=flat-square&colorA=191b25)](https://github.com/LucasCtrl/spookyBot/stargazers) +[![forks](https://img.shields.io/github/forks/LucasCtrl/spookyBot.svg?style=flat-square&colorA=191b25)](https://github.com/LucasCtrl/spookyBot/network) + +## 👤 Author + +**LucasAlt** +* Website: https://www.lucasalt.fr +* Twitter: [@LucasCtrlAlt](https://twitter.com/LucasCtrlAlt) +* GitHub: [@LucasCtrl](https://github.com/LucasCtrl) + +## 🤝 Contributing + +This project is convenient for people who want to get into open source and contribute to different projects especially during the Hacktoberfest. +If you want to add your language to the robot, feel free to copy the `./lang/en.js` file, rename it following the [following nomenclature](http://www.mathguide.de/info/tools/languagecode.html). + +Then, all you have to do is modify the file, open a pull request and wait for me to approve it and update the robot. + +*Don't hesitate to ask me for help on my [Discord server](https://discord.gg/nEDcagb), I would help you with great pleasure!* + +1. Fork it (https://github.com/LucasCtrl/spookyBot/fork) +2. Create your feature branch (`git checkout -b feature/fooBar`) +3. Commit your changes (`git commit -am 'Add some fooBar'`) +4. Push to the branch (`git push origin feature/fooBar`) +5. Create a new Pull Request + +## Show your support + +Give a ⭐️ if you like this project! + + + Buy Me a Coffee at ko-fi.com + + +## 📝 License + +This project is open source and available under the [MIT](https://github.com/LucasCtrl/spookyBot/blob/master/LICENSE)