Skip to content

Commit 3edf9c5

Browse files
committed
docs: improve README
1 parent d9053d5 commit 3edf9c5

File tree

1 file changed

+29
-18
lines changed

1 file changed

+29
-18
lines changed

README.md

Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,30 @@
1+
[![Harmonix banner](./.github/assets/banner.svg)](https://harmonix-js.netlify.app)
2+
3+
<p align=center>
4+
<a href="https://www.npmjs.com/package/@harmonix-js/core"><img src="https://img.shields.io/npm/v/@harmonix-js/core?style=flat&colorA=191717&colorB=4b43ee" alt="Version"></a>
5+
<a href="https://www.npmjs.com/package/@harmonix-js/core"><img src="https://img.shields.io/npm/dm/@harmonix-js/core.svg?style=flat&colorA=191717&colorB=4b43ee" alt="Downloads"></a>
6+
<a href="./LICENSE"><img src="https://img.shields.io/github/license/harmonix-js/core.svg?style=flat&colorA=191717&colorB=4b43ee" alt="License"></a>
7+
<a href="https://harmonix-js.netlify.app"><img src="https://img.shields.io/badge/Harmonix%20Docs-18181B?logo=gitbook&logoColor=4b43ee" alt="Website"></a>
8+
<a href="https://discord.gg/A3rVnG4JGV"><img src="https://img.shields.io/badge/Harmonix%20Discord-18181B?logo=discord" alt="Discord"></a>
9+
</p>
10+
111
# Harmonix
212

3-
Create Discord Bot with ease and simplicity.
13+
🤖 Open-source framework to make Discord bots.
414

5-
## Examples
15+
## ⚡ Quick Start
616

7-
### Installation
17+
This will set up a starter project complete with all the essential files and dependencies:
818

919
```bash
10-
npx @harmonix-js/cli init bot-name
11-
# pnpm dlx @harmonix-js/cli init bot-name
12-
# yarn dlx @harmonix-js/cli init bot-name
20+
npx @harmonix-js/cli init <my-bot>
1321
```
1422

15-
#### Command
23+
## 📡 Development
1624

17-
`commands/utils/ping.ts`
25+
Harmonix offers a straightforward, user-friendly, and robust solution for writing commands naturally. It automates all repetitive tasks, allowing you to concentrate on developing your bot features with assurance.
1826

27+
Example of an `commands/ping.ts`:
1928
```ts
2029
import { defineCommand } from '@harmonix-js/core'
2130

@@ -29,19 +38,21 @@ export default defineCommand(
2938
)
3039
```
3140

32-
#### Event
41+
## 📖 Documentation
3342

34-
`events/ready.ts`
43+
Check out the Harmonix documentation to enhance your skills. It's an excellent resource for deepening your understanding of the framework, covering a large bunch of topics.
3544

36-
```ts
37-
import { defineEvent } from '@harmonix-js/core'
45+
## 🤝 Contribution
3846

39-
export default defineEvent<'ready'>((client) => {
40-
console.log('Bot is ready!')
41-
})
42-
```
47+
We welcome your support to enhance Harmonix. To do that you can report bugs or give us feedback and ideas.
4348

44-
## License
49+
## ⚖️ License
4550

4651
Published under the [MIT](https://github.com/harmonix-js/core/blob/main/LICENSE) license.
47-
Made by [@nethriis](https://github.com/nethriis) 🖤
52+
53+
## 🌱 Contributors
54+
55+
<a href="https://github.com/harmonix-js/core/graphs/contributors">
56+
<img src="https://contrib.rocks/image?repo=harmonix-js/core" />
57+
</a>
58+

0 commit comments

Comments
 (0)