mirror of
https://github.com/tiramisulabs/seyfert.git
synced 2025-07-01 20:46:08 +00:00
58 lines
1.7 KiB
Markdown
58 lines
1.7 KiB
Markdown
<div align='center'>
|
|
|
|
# **Seyfert**
|
|
|
|
<img src="./assets/icon.png" alt="seyfert" width="200px" />
|
|
|
|
**A brand new bleeding edge non bloated Discord framework**
|
|
|
|
[](https://github.com/tiramisulabs/seyfert/blob/main/LICENSE)
|
|
[](https://www.npmjs.com/package/seyfert)
|
|
[](https://discord.com/invite/XNw2RZFzaP)
|
|
|
|
</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.
|
|
|
|
## Why I should use it?
|
|
Seyfert has a good scalability, strict types, smooth developing experience...
|
|
|
|
> 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
|
|
```sh
|
|
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)
|