Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #41

Open
wants to merge 1 commit into
base: development
Choose a base branch
from
+11 −8
Open

Update README.md #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
</a>
</center>

Logger is a powerful [Discord](https://discordapp.com) bot meant to give staff members oversight over the various actions taking place in their server. Come talk about me with my creator at [Logger's Lounge](https://discord.gg/ed7Gaa3).

Logger is a powerful [Discord](https://discordapp.com) bot designed to provide staff members with comprehensive oversight over various actions in their server. With features such as message deletion tracking, user moderation history, and channel activity logs, Logger enables server administrators to efficiently monitor and manage server activity. For more information about Logger and its capabilities, feel free to join the discussion with my creator at [Logger's Lounge](https://discord.gg/ed7Gaa3).

## Installation

Expand All @@ -30,10 +31,12 @@ node index.js
```

## Contributing
Pull requests are welcome as long as it follows the following guidelines:
1. Is your idea really one that a large group of moderators would like?
2. Is your idea scalable?
3. Will your idea cause the bot to hit it's global ratelimit?
4. Have you proposed it to *piero#5432* in my [support server?](https://discord.gg/ed7Gaa3)

If you have done all of the above steps, then open a pull request and I will review it. Style guide and testing will be implemented in a later update.
Pull requests are welcome if they follow these guidelines:
- Your idea should be one that a large group of moderators would find useful.
- Your idea should be scalable, so that it can handle large volumes of traffic without performance issues.
- Your idea should not cause the bot to hit its global ratelimit.
- You should propose your idea to *piero#5432* in the [support server?](https://discord.gg/ed7Gaa3).
- Please provide as much detail as possible about your idea to make the review process smoother.

Style guide and testing information will be implemented in a later update. In the meantime, please do your best to follow best practices and test thoroughly before submitting a pull request.
For more information, please refer to the support server and any relevant documentation or resources