This repository has been archived on 2024-11-13. You can view files and clone it, but cannot push or open issues or pull requests.
Ellie-bot/README.md

88 lines
3.6 KiB
Markdown
Raw Normal View History

2022-08-02 12:04:58 +00:00
# Ellie Discord Bot ©2018-2022 EllieBotDevs
2022-07-25 14:07:00 +00:00
2022-01-07 10:25:09 +00:00
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
2022-09-03 04:26:30 +00:00
[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
2022-01-07 10:25:09 +00:00
<!-- ALL-CONTRIBUTORS-BADGE:END -->
2022-01-06 01:08:23 +00:00
![](https://cdn.discordapp.com/attachments/765441543100170271/914327948667011132/Ellie_Concept_2_transparent_ver.png?size=2048)
2022-07-08 13:48:22 +00:00
## Badges
2022-08-05 22:44:22 +00:00
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=EllieBotDevs_Ellie-bot&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=EllieBotDevs_Ellie-bot) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=EllieBotDevs_Ellie-bot&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=EllieBotDevs_Ellie-bot) [![Automated Release Notes by gren](https://img.shields.io/badge/%F0%9F%A4%96-release%20notes-00B2EE.svg)](https://github-tools.github.io/github-release-notes/)
2022-07-08 13:48:22 +00:00
2022-01-06 01:08:23 +00:00
## Contribution Guide
```
1.Fork this repository
2022-07-22 13:05:43 +00:00
2.Clone your fork: git clone https://github.com/your-username/Ellie-bot.git
2022-01-06 01:08:23 +00:00
3.Create your feature branch: git checkout -b my-new-feature
4.Commit your changes: git commit -am 'Add some feature'
5.Push to the branch: git push origin my-new-feature
6.Submit a pull request
```
## Installation
2022-07-25 14:07:00 +00:00
This is coming soon (if you wish to help join our [Discord Server] and let Emotion know)
2022-01-06 01:08:23 +00:00
## Privacy
2022-07-25 14:07:00 +00:00
This is coming soon (if you wish to help join our [Discord Server] and let Emotion know)
2022-01-06 01:08:23 +00:00
## Code of conduct
2022-01-07 10:27:42 +00:00
Please read our [code of conduct](CODE_OF_CONDUCT.md) before contributing
2022-01-06 01:08:23 +00:00
## Disclaimer
This bot is in an early alpha stage and any help is very much appreciated
2022-07-25 14:07:00 +00:00
Also please only push changes to the [Development Branch](https://github.com/EllieBotDevs/Ellie-bot/tree/development)
2022-01-06 01:08:23 +00:00
## Discord Server
2022-07-25 14:07:00 +00:00
If you have any issues you can join our [Discord Server]
2022-01-06 01:08:23 +00:00
## Changelog
If you would like to see our progress you can view our [changelog](CHANGELOG.md)
## Licence
2022-08-02 12:04:58 +00:00
```
2022-08-02 12:06:30 +00:00
Copyright 2022 EllieBotDevs
2022-08-02 12:04:58 +00:00
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
2022-08-02 12:06:30 +00:00
To learn more about this license follow the link above or you can view it in the [LICENSE](LICENSE)
2022-01-07 10:25:09 +00:00
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
2022-09-03 04:08:11 +00:00
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="http://banditco.dev"><img src="https://avatars.githubusercontent.com/u/84136868?v=4?s=100" width="100px;" alt=""/><br /><sub><b>AidanTheBandit</b></sub></a><br /><a href="https://github.com/EllieBotDevs/Ellie-bot/commits?author=AidanTheBandit1" title="Code">💻</a></td>
2022-09-03 04:31:06 +00:00
<td align="center"><a href="https://www.emotionchild.com"><img src="https://avatars.githubusercontent.com/u/36905598?v=4?s=100" width="100px;" alt=""/><br /><sub> <b>Emotion</b></sub></a><br /><a href="https://github.com/EllieBotDevs/Ellie-v4/commits?author=EmotionChild" title="Code">💻</a></td>
2022-01-07 10:25:09 +00:00
</tr>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
2022-09-13 01:41:59 +00:00
[Discord Server]: https://discord.elliebot.net