Skip to content

Commit

Permalink
style: apply linting to .md and .yaml files
Browse files Browse the repository at this point in the history
  • Loading branch information
e-enes committed Apr 6, 2024
1 parent fd928ff commit 9e3d101
Show file tree
Hide file tree
Showing 2 changed files with 768 additions and 759 deletions.
32 changes: 21 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,46 +8,56 @@
### The Best Way to Track Your Discord Server's Invites!

## Requirements
* Node.js version 18.x.x or higher
* A Discord bot token

- Node.js version 18.x.x or higher
- A Discord bot token

## Features
* Precise tracking of each member's server invitations
* Access to an invitation leaderboard to see who's on top
* Ability to manually adjust member invites, adding or removing as needed
* Option to reset a member's invite count to zero
* Advanced detection of fraudulent invitations
* Plus, many more exciting features...

- Precise tracking of each member's server invitations
- Access to an invitation leaderboard to see who's on top
- Ability to manually adjust member invites, adding or removing as needed
- Option to reset a member's invite count to zero
- Advanced detection of fraudulent invitations
- Plus, many more exciting features...

## Quick Start Guide

**Step 1**: Clone the repository to get started:

```
git clone https://github.com/e-enes/invitron.git
cd invitron
```

**Step 2**: Install all necessary dependencies:

```
pnpm install
```
*Note: If `pnpm` is not already installed, you can install it globally using `npm i -g pnpm`.*

_Note: If `pnpm` is not already installed, you can install it globally using `npm i -g pnpm`._

**Step 3**: Set up your `.env` and `src/config.ts` files:

```
mv .env.example .env
```

Then, fill in the required information accordingly.

5. Start:

```
pnpm build && pnpm start
pnpm build && pnpm sta
```

Finally, execute the `/setup` command on discord.

## Join Our Contributors!

We warmly welcome contributions! Whether you're suggesting new features, reporting bugs, or directly contributing to the code, your input is invaluable. Feel free to open an issue or submit a pull request to join our growing community.

## License
Invitron is proudly licensed under the MIT License. For more details, please see the [LICENSE](https://github.com/e-enes/Invitron/blob/main/LICENSE) file.

Invitron is proudly licensed under the MIT License. For more details, please see the [LICENSE](https://github.com/e-enes/Invitron/blob/main/LICENSE) file.
Loading

0 comments on commit 9e3d101

Please sign in to comment.