discord-leveling-super/README.md

Easy and customizable leveling framework for your Discord bot.

# Discord Leveling Super

[![Downloads](https://img.shields.io/npm/dt/discord-leveling-super?style=for-the-badge)](https://www.npmjs.com/package/discord-leveling-super)
[![Stable Version](https://img.shields.io/npm/v/discord-leveling-super?style=for-the-badge)](https://www.npmjs.com/package/discord-leveling-super)

<b>Discord Leveling Super</b> - Easy and customizable leveling framework for your [Discord Bot](https://discord.js.org/#/).

## ❓ | Why?
<ul>
<li><b>TypeScript Support 📘</b></li>
<li><b>Object-oriented 📜</b></li>
<li><b>Flexible and Customizable ⚙️</b></li>
<li><b>Easy to use 👍</b></li>
<li><b>Beginner Friendly 😄</b></li>
<li><b>Multi-Server Setup 🏦</b></li>
</ul>

## 📂 | Installation
<b>Note:</br><b>
<b>Node.js >=16.6.0 and Discord.js >=13.1.0 is required.</b><br>
```console
npm i discord-leveling-super
yarn add discord-leveling-super
pnpm add discord-leveling-super
```

## [[Module Documentation]](https://dls-docs.js.org)


## 🤓 | How to use?
### 1. Run `npm i discord-leveling-super`.
### 2. Do `require` or `import` in your code to use the module like this:
```js
const Leveling = require('discord-leveling-super')
// or:
import Leveling from 'discord-leveling-super'
```

## Or:

### 1. [Clone this repository](https://github.com/shadowplay1/discord-leveling-super/archive/refs/heads/main.zip).
### 2. Run `npm run build` or `build.bat` file.
### 3. Do `require` or `import` the `dist/index` path in your code to use the module like this:
```js
const Leveling = require('dist/index')
// or:
import Leveling from 'dist/index'
```

## 🤔 | Help
<b>If you don't understand something in the documentation or you are experiencing problems, feel free to join our <a href = "https://discord.gg/4pWKq8vUnb">Support Server</a>.</b>

## ❗ | Useful Links
<ul>
<li><b><a href = "https://dls-docs.js.org">Documentation</a></b></li>
<li><b><a href = "https://dls-docs.js.org/#/docs/main/1.0.5/general/faq">Frequently Asked Questions</a></b></li>
<li><b><a href = "https://www.npmjs.com/package/discord-leveling-super">NPM</a></b></li>
<li><b><a href = "https://github.com/shadowplay1/discord-leveling-super">GitHub</a></b></li>
<li><b><a href = "https://github.com/shadowplay1/discord-leveling-super/tree/main/examples">Examples</a></b></li>
<li><b><a href = "https://discord.gg/4pWKq8vUnb">Discord Server</a></b></li>
</ul>
<b>If you found a bug, have any questions or need help, join the <a href = "https://discord.gg/4pWKq8vUnb">Support Server</a>.</b>
<br>
<b>Module Created by ShadowPlay.</b>

# ❤️ Thanks for using Discord Leveling Super ❤️