diff --git a/README.md b/README.md index 6516876..5bab4ff 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,46 @@ +![python 3.8+](https://img.shields.io/badge/python-3.8+-blue) +[![tokei lines of code](https://tokei.rs/b1/git.zevaryx.com/stark-industries/j.a.r.v.i.s.?category=code)](https://git.zevaryx.com/stark-industries/j.a.r.v.i.s.) +[![discord chat widget](https://img.shields.io/discord/862402786116763668?style=social&logo=discord)](https://discord.gg/VtgZntXcnZ) + J.A.R.V.I.S # Just Another Very Intelligent System (J.A.R.V.I.S.) -Welcome to the J.A.R.V.I.S. Initiative! While the main goal is to create the best discord bot there can be. A great achievement would be to present him to the Robots and have him integrated into the dbrand server. Feel free to suggest anything you may think to be useful… or cool. +Welcome to the J.A.R.V.I.S. Initiative! While the main goal is to create the best discord bot there can be, a great achievement would be to present him to the Robots and have him integrated into the dbrand server. Feel free to suggest anything you may think to be useful… or cool. **Note:** Some commands have been custom made to be used in the dbrand server. ## Features -Currently J.A.R.V.I.S offers: +J.A.R.V.I.S. currently offers: -* 👩‍💼 **Administration**: `verify`, `ban/unban`, `kick`, `purge`, `mute/unmute` and more! -* 🚓 **Moderation**: `lock/unlock`, `lockdown`, `warn`, `autoreact`, and also more! -* 👻 **Fun**: `jokes`. Please proceed to laugh now. -* 👑 **dbrand**: `ctc2` and other shit that I cba to explain! +- 👩‍💼 **Administration**: `verify`, `ban/unban`, `kick`, `purge`, `mute/unmute` and more! +- 🚓 **Moderation**: `lock/unlock`, `lockdown`, `warn`, `autoreact`, and also more! +- 👻 **Fun**: `jokes`. Please proceed to laugh now. +- 👑 **dbrand**: `ctc2` and other dbrand-specific commands. [Join their server](https://discord.gg/dbrand) to see them in action! ## Contributing Before **creating an issue**, please ensure that it hasn't already been reported/suggested. -And if you have a question, please DM {insert random ass here} instead of opening an issue. -If you wish to contribute to the J.A.R.V.I.S codebase or documentation, feel free to fork the repository and submit a pull request! +If you have a question, please join the community Discord before opening an issue. + + +If you wish to contribute to the J.A.R.V.I.S codebase or documentation, join the Discord! The recognized developers there will help you get started. + +## Community + +Join the [Stark R&D Department Discord server](https://discord.gg/VtgZntXcnZ) to be kept up-to-date on code updates and issues. + +## Requirements +- MongoDB 4.4 or higher +- Python 3.8 or higher +- [tokei](https://github.com/XAMPPRocky/tokei) 12.1 or higher + +On top of the above requirements, the following pip packages are also required: +- `discord-py>=1.7, <2` +- `psutil>=5.8, <6` +- `GitPython>=3.1, <4` +- `PyYaml>=5.4, <6` +- `discord-py-slash-command>=2.3, <3` +- `pymongo>=3.12.0, <4` +- `opencv-python>=4.5, <5` diff --git a/requirements.txt b/requirements.txt index bfdb75e..88ec417 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,7 @@ -discord-py>=1.7, <1.8 -psutil>=5.8, <5.9 -GitPython>=3.1, <3.2 -PyYaml>=5.4, <5.5 +discord-py>=1.7, <2 +psutil>=5.8, <6 +GitPython>=3.1, <4 +PyYaml>=5.4, <6 +discord-py-slash-command>=2.3, <3 +pymongo>=3.12.0, <4 +opencv-python>=4.5, <5