mirror of
https://github.com/tiramisulabs/seyfert.git
synced 2025-07-01 20:46:08 +00:00
Updated readme
This commit is contained in:
parent
d8a4bc1bd3
commit
f51ae31ea3
37
README.md
37
README.md
@ -4,7 +4,7 @@
|
||||
|
||||
<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**
|
||||
|
||||
[](https://github.com/tiramisulabs/seyfert/blob/main/LICENSE)
|
||||
[](https://www.npmjs.com/package/seyfert)
|
||||
@ -12,19 +12,22 @@
|
||||
|
||||
</div>
|
||||
|
||||
> [!WARNING]
|
||||
> This readme is work in progress!
|
||||
|
||||
# FAQ
|
||||
## 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?
|
||||
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
|
||||
> [!NOTE]
|
||||
> 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.
|
||||
|
||||
## 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
|
||||
|
||||
- [GitHub Repository](https://github.com/tiramisulabs/seyfert)
|
||||
- [Discord server](https://discord.com/invite/XNw2RZFzaP)
|
||||
- [npm - core](https://www.npmjs.com/package/seyfert)
|
||||
- [Website](https://seyfert.dev)
|
||||
- [Documentation](https://docs.seyfert.dev)
|
||||
|
Loading…
x
Reference in New Issue
Block a user