From ccdfdb0a534b3c88b2d1a417885b9ecc585ffb4a Mon Sep 17 00:00:00 2001
From: Declan Chidlow <84255570+DeclanChidlow@users.noreply.github.com>
Date: Thu, 8 Feb 2024 01:05:24 +0800
Subject: [PATCH] doc: improve README (#90)

Improves formatting, fixes grammar and punctuation, and generally cleans up file.
---
 README.md | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 2ab36ef9..a0aca4a6 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,7 @@
 # revolt.js
 
-> **Warning**
-> revolt.js is currently being rewritten, it's pretty much ready for use for most applications but is still not entirely feature complete.
->
+> [!WARNING]
+> revolt.js is currently being rewritten. While it's ready for use for most applications, it is still not entirely feature complete. \
 > You can find the [version 6 README here](https://github.com/revoltchat/revolt.js/tree/v6).
 
 ![revolt.js](https://img.shields.io/npm/v/revolt.js) ![revolt-api](https://img.shields.io/npm/v/revolt-api?label=Revolt%20API)
@@ -49,10 +48,10 @@ function MyApp() {
 
 ## Revolt API Types
 
-All `revolt-api` types are re-exported from this library under `API`.
+> [!WARNING]
+> It is advised you do not use this unless necessary. If you find somewhere that isn't covered by the library, please open an issue as this library aims to transform all objects.
 
-> **Warning**
-> It is advised you do not use this unless necessary, if you find somewhere that isn't covered by the library, please open an issue as this library aims to transform all objects.
+All `revolt-api` types are re-exported from this library under `API`.
 
 ```typescript
 import { API } from "revolt.js";