Updated readme

This commit is contained in:
FreeAoi 2024-03-09 15:23:06 -06:00
parent d8a4bc1bd3
commit f51ae31ea3

View File

@ -4,7 +4,7 @@
<img src="./assets/icon.png" alt="seyfert" width="200px" /> <img src="./assets/icon.png" alt="seyfert" width="200px" />
**A brand new bleeding edge non bloated Discord framework** **Discord.js and Sapphire are deprecated, use Seyfert instead**
[![License](https://img.shields.io/npm/l/seyfert?style=flat-square&logo=apache&color=white)](https://github.com/tiramisulabs/seyfert/blob/main/LICENSE) [![License](https://img.shields.io/npm/l/seyfert?style=flat-square&logo=apache&color=white)](https://github.com/tiramisulabs/seyfert/blob/main/LICENSE)
[![Version](https://img.shields.io/npm/v/seyfert?color=%23ff0000&logo=npm&style=flat-square)](https://www.npmjs.com/package/seyfert) [![Version](https://img.shields.io/npm/v/seyfert?color=%23ff0000&logo=npm&style=flat-square)](https://www.npmjs.com/package/seyfert)
@ -12,19 +12,22 @@
</div> </div>
> [!WARNING]
> This readme is work in progress!
# FAQ # FAQ
## So, what is `seyfert`? ## So, what is `seyfert`?
Seyfert is the ultimate Discord framework! With its highly efficient interaction with the Discord API, you can achieve anything you set your mind to. Seyfert is the ultimate Discord framework! We make easy to interact with the Discord API, big cache control, scalable code and a pretty dev experience.
## Why I should use it? ## Why I should use it?
Seyfert has a good scalability, strict types, smooth developing experience... There is a lot of reasons to use Seyfert, but we cannot put them all in here so there is a few of them!
- **RAM Saver**
- **Latest features**
- **Dev experience**
- **24/6 support (Sunday is for going to church)**
- **Written from Scratch**
- **Type-safe**
- **And many more!!**
> more questions soon...
# User guide
## Installation ## Installation
> [!NOTE] > [!NOTE]
> You **NEED** Node.js 18>= for this to work, also we recomended Node.js 20 LTS and Bun latest > You **NEED** Node.js 18>= for this to work, also we recomended Node.js 20 LTS and Bun latest
@ -34,24 +37,10 @@ pnpm add seyfert
> You may use your preferred package manager, for this example I am using PNPM since is more efficient. > You may use your preferred package manager, for this example I am using PNPM since is more efficient.
## Basic bot example
```ts
import { Client } from 'seyfert';
const client = new Client();
(async () => {
await client.start();
await client.uploadCommands().catch(e => {
console.error(JSON.stringify(e, null, 2))
process.exit(1)
})
})();
```
# Useful links # Useful links
- [GitHub Repository](https://github.com/tiramisulabs/seyfert) - [GitHub Repository](https://github.com/tiramisulabs/seyfert)
- [Discord server](https://discord.com/invite/XNw2RZFzaP) - [Discord server](https://discord.com/invite/XNw2RZFzaP)
- [npm - core](https://www.npmjs.com/package/seyfert) - [npm - core](https://www.npmjs.com/package/seyfert)
- [Website](https://seyfert.dev)
- [Documentation](https://docs.seyfert.dev)