From 4e9530f4d7d41f3949f574501ef7b66932186401 Mon Sep 17 00:00:00 2001
From: Jacob Nguyen <76754747+jacoobes@users.noreply.github.com>
Date: Sun, 14 Aug 2022 12:50:07 -0500
Subject: [PATCH] docs(readme): @Murtatrxx work readme improvements (#104)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* docs: 🦋 Refreshed README

* docs: Imrpoved hero image

* docs: Changed the title

* fix: Fixed the title display

* docs: Added copyright to README

* docs: Added more badges

* docs: Updated license badge

* docs: Fixed message grammar

* fix: Fixed the line count

* docs: Shortened the description

* revert: Remove copyright

* docs: Updated the name on README

* docs: Added bun to installations

* ci: version.txt

* ci: simple release-type

* chore: Added .vscode/ dir to ignore file

* docs: Improved readme

* docs: Requested changes

* docs: Updated readme with more details

* feat: update banner

* feat: update readme

* docs: Updated features section’s title

* docs: Requested changes

* fix: Grammar

* feat: delete version.txt

* chore: update release-please

* docs: fixed typo

Co-authored-by: xxDeveloper <77380166+Murtatrxx@users.noreply.github.com>
---
 .gitignore |  3 +++
 README.md  | 62 +++++++++++++++++++++++++++++++++++++++++-------------
 2 files changed, 50 insertions(+), 15 deletions(-)

diff --git a/.gitignore b/.gitignore
index f208b31..2f0476a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -82,5 +82,8 @@ dist
 # VisualStudio Config file
 .vs
 
+# VSCode settings and cache
+.vscode
+
 # IntelliJ IDEA Config file
 .idea/
diff --git a/README.md b/README.md
index a118454..fbec6b5 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,21 @@
-# SernHandler
+<div align="center">
+  <img src="https://raw.githubusercontent.com/sern-handler/.github/main/banner.png" width="900px">
+</div>
 
-<a href="https://www.npmjs.com/package/@sern/handler"><img src="https://img.shields.io/npm/v/@sern/handler?maxAge=3600" alt="NPM version" /></a>
-<a href="https://www.npmjs.com/package/@sern/handler"><img src="https://img.shields.io/npm/dt/@sern/handler?maxAge=3600" alt="NPM downloads" /></a>
-[![License: MIT](https://img.shields.io/badge/License-MIT-blavk.svg)](https://opensource.org/licenses/MIT)
+<h1 align="center">Handlers. Redefined.</h1>
+<h4 align="center">A customizable, batteries-included, powerful discord.js framework to streamline bot development.</h4>
 
-A customizable, batteries-included, powerful discord.js framework to automate and streamline your bot development.
+<div align="center" style="margin-top: 10px">
+  <img src="https://img.shields.io/badge/open-source-brightgreen">
+  <a href="https://www.npmjs.com/package/@sern/handler"><img src="https://img.shields.io/npm/v/@sern/handler?maxAge=3600" alt="NPM version" /></a>
+  <a href="https://www.npmjs.com/package/@sern/handler"><img src="https://img.shields.io/npm/dt/@sern/handler?maxAge=3600" alt="NPM downloads" /></a>
+  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-brightgreen" alt="License MIT"></a>
+  <a href="https://sern-handler.js.org"><img alt="docs.rs" src="https://img.shields.io/docsrs/docs"></a>
+  <img alt="Lines of code" src="https://img.shields.io/badge/total%20lines-2k-blue">
+</div>
 
 
-## Installation
+## 📜 Installation
 
 ```sh
 npm install @sern/handler
@@ -21,13 +29,26 @@ yarn add @sern/handler
 pnpm add @sern/handler
 ```
 
-## Basic Usage
+## 👀 Quick Look
+
+* Support for discord.js v14 and all interactions
+* Hybrid commands
+* lightweight and customizable
+* ESM, CommonJS and TypeScript support
+* A powerful cli and awesome community-made plugins
+
+## 👶 Basic Usage
 
 #### ` index.js (CommonJS)`
 
 ```js
+// Import the discord.js Client and GatewayIntentBits
 const { Client, GatewayIntentBits } = require('discord.js');
+
+// Import Sern namespace
 const { Sern } = require('@sern/handler');
+
+// Our configuration file
 const { defaultPrefix, token } = require('./config.json');
 
 const client = new Client({
@@ -39,9 +60,9 @@ const client = new Client({
 });
 
 Sern.init({
-    client,   
-    defaultPrefix,   
-    commands : 'src/commands',
+  client,   
+  defaultPrefix,   
+  commands : 'src/commands',
 });
 
 client.login(token);
@@ -50,6 +71,17 @@ client.login(token);
 #### ` ping.js (CommonJS)`
 
 ```js
+const { CommandType } = require('@sern/handler');
+
+exports.default = commandModule({
+  name: 'ping',
+  description: 'A ping pong command',
+  type: CommandType.Slash,
+  execute(ctx) {
+    ctx.reply('pong!');
+  }
+});
+
 const { Sern, CommandType } = require('@sern/handler');
 
 exports.default = commandModule({
@@ -63,21 +95,21 @@ exports.default = commandModule({
 
 See our [templates](https://github.com/sern-handler/templates) for TypeScript examples and more
 
-## CLI
+## 💻 CLI
 
 It is **highly encouraged** to use the [command line interface](https://github.com/sern-handler/cli) for your project. Don't forget to view it.
 
-## Links
+## 🔗 Links
 
-- [Official Documentation](https://sern-handler.js.org)
+- [Official Documentation and Guide](https://sern-handler.js.org)
 - [Support Server](https://discord.com/invite/mmyCTnYtbF)
 
-## Contribute
+## 👋 Contribute
 
 - Read our contribution [guidelines](https://github.com/sern-handler/handler) carefully
 - Pull up on [issues](https://github.com/sern-handler/handler/issues) and report bugs
 - All kinds of contributions are welcomed.
 
-## Roadmap
+## 🚈 Roadmap
 
 You can check our [roadmap](https://github.com/sern-handler/roadmap) to see what's going to be added or patched in the future.