Skip to content

Commit 159086c

Browse files
committed
chore: update readme's
1 parent 653b59e commit 159086c

File tree

4 files changed

+47
-15
lines changed

4 files changed

+47
-15
lines changed

.changeset/early-cherries-poke.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'create-jellycommands': patch
3+
'jellycommands': patch
4+
---
5+
6+
update readme's

README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,22 @@
1212

1313
<br />
1414

15+
<div align="center">
1516

17+
Jellycommands is a developer experience focused command framework for discord.js. It has support for all types of application commands, including slash commands and context menus. It also includes quality of life features such as caching and developer mode.
1618

17-
# [Read the docs](https://ghostdevbusiness.gitbook.io/jellycommands/)
18-
19+
<br />
1920

20-
# Running in dev mode
21-
Requirements:
22-
- NPM 7
23-
- Node 14
21+
## [Documentation](https://ghostdevbusiness.gitbook.io/jellycommands/)
2422

25-
Running in dev mode:
26-
```
27-
cd dev
28-
npm install
29-
cd ..
30-
npm run dev
31-
```
23+
</div>
3224

3325
# Support
34-
Want to support JellyCommands? Amazing, you can do it in a few ways:
26+
27+
- ### Join the [discord](https://discord.gg/2Vd4wAjJnm)
28+
- ### Create a issue on the [github](https://github.com/ghostdevv/jellycommands)
29+
30+
# Support Development
3531

3632
- ### Patreon / PayPal
3733
[Click me](https://ghostdev.xyz/donate)
@@ -46,3 +42,4 @@ Want to support JellyCommands? Amazing, you can do it in a few ways:
4642
The badge:
4743
4844
[![JellyCommands](https://img.shields.io/badge/Powered%20by%20-Jelly%20Commands-EB5E8A?style=for-the-badge&labelColor=white)](https://github.com/ghostdevv/jellycommands)
45+

packages/create-jellycommands/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Create JellyCommands
22

3-
This is the package for the official jellycommands project creation cli, you can checkout the [main repo here](https://github.com/ghostdevv/jellycommands)
3+
This is the package for the official [jellycommands](https://github.com/ghostdevv/jellycommands) project creation cli, you can checkout the [main repo here](https://github.com/ghostdevv/jellycommands)
44

55
# Use CLI
66

packages/jellycommands/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<div align="center">
2+
3+
![](https://raw.githubusercontent.com/ghostdevv/jellycommands/main/assets/jellycommands-banner.png)
4+
5+
`npm install jellycommands`
6+
7+
[![](https://img.shields.io/npm/v/jellycommands?label=Latest%20Version&style=for-the-badge&logo=npm&color=informational)](https://www.npmjs.com/package/jellycommands)
8+
9+
</div>
10+
11+
---
12+
13+
<br />
14+
15+
# What is JellyCommands
16+
17+
Jellycommands is a developer experience focused command framework for discord.js. It has support for all types of application commands, including slash commands and context menus. It also includes quality of life features such as caching and developer mode.
18+
19+
# Get Started
20+
21+
The best way to get started is using our cli:
22+
23+
```bash
24+
npm init jellycommands my-project
25+
```
26+
27+
# Documentation
28+
29+
[You can view the documentation here](https://ghostdevbusiness.gitbook.io/jellycommands/)

0 commit comments

Comments
 (0)