tiramisu/seyfert
5
0
Fork 0
mirror of https://github.com/tiramisulabs/seyfert.git synced 2025-07-01 20:46:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: some readme tweaks (#211)

Browse Source 
* chore: some readme tweaks

* fix: specify flags on readme
This commit is contained in:
simxnet 2024-06-22 00:45:19 +02:00 committed by GitHub
parent 026805bcb2
commit af678b88f7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1,7 +1,4 @@
<div align='center'> <div align='center'>
# **Seyfert**
<img src="./assets/icon.png" alt="seyfert" width="200px" /> <img src="./assets/icon.png" alt="seyfert" width="200px" />
**Discord.js and Sapphire are deprecated, use Seyfert instead** **Discord.js and Sapphire are deprecated, use Seyfert instead**
@ -12,11 +9,11 @@
</div> </div>
# FAQ ## FAQ
## So, what is `seyfert`? ### So, what is `seyfert`?
Seyfert is the ultimate Discord framework! We make it easy to interact with the Discord API, big cache control, scalable code and a pretty dev experience. Seyfert is the ultimate Discord framework! We make it easy to interact with the Discord API, big cache control, scalable code and a pretty dev experience.
## Why should I use it? ### Why should I use it?
There are many reasons to use Seyfert, but they dont all fit in this tiny readme, so here is a list of the most awesome reasons! There are many reasons to use Seyfert, but they dont all fit in this tiny readme, so here is a list of the most awesome reasons!
- **Low RAM Usage** - **Low RAM Usage**
@ -30,14 +27,25 @@ There are many reasons to use Seyfert, but they dont all fit in this tiny readme
## Installation ## Installation
> [!NOTE] > [!NOTE]
> You **NEED** Node.js 18>= for this to work, Node.js 20 LTS and Bun latest are recommended > Node v18>= is required (or v16 with `--experimental-fetch` flag), Bun/Node LTS recommended.
```sh ```sh
pnpm add seyfert pnpm add seyfert
``` ```
> You may use your preferred package manager, for this example PNMP is being used since it’s more efficient. ```sh
bun add seyfert
```
# Useful links ```sh
npm i seyfert
```
> Or other package manager.
## Contributing
We are open to contributions, fork the repo and make your changes!
## 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)