Skip to content

Commit

Permalink
Description updates (#95)
Browse files Browse the repository at this point in the history
* Update package description

* Slightly restructure readme, update introduction
  • Loading branch information
eritbh authored Aug 22, 2021
1 parent 7a9dc84 commit bd5f5c1
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 14 deletions.
33 changes: 20 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,43 +6,50 @@
[![Discord support server](https://img.shields.io/discord/409839835503788033?color=7289DA&label=support%20server&logo=discord&logoColor=fff)](https://discord.gg/a2N2YCx)
[![Donate on Ko-fi](https://img.shields.io/badge/donate-on%20Ko--fi-FF5E5B?logo=ko-fi&logoColor=white)](https://ko-fi.com/eritbh)

A zero-dependency Discord command framework for Javascript and Typescript, based on [Eris](https://github.com/abalabahaha/eris). [Read the Documentation.](https://eritbh.me/yuuko)
A no-frills Discord command framework for [Eris](https://github.com/abalabahaha/eris).

The goal of this module is to provide a starting point for bots of all sizes. Yuuko provides sane defaults and easily-configurable options for new developers, and is written to be easily extensible for those needing more control.
Yuuko's goal is to provide a solid base for Discord bots of all types and sizes, featuring easy support for modular project structures, multiple levels of configuration hooks, and first-class Typescript compatibility in a lightweight package with no extra dependencies. [Read the usage guide][usage] or [check the full API reference][docs].

## Installation

Yuuko expects Eris to be installed as a peer dependency, which allows you to use any forward-compatible Eris version without having to wait for an update to Yuuko. Using npm, you can install both at once with this command:
Yuuko expects Eris to be installed as a peer dependency, which allows you to use any forward-compatible Eris version without having to update Yuuko first. Using npm, you can install both at once with this command:

```bash
$ npm install yuuko eris
```

Generally, the latest version of Eris is the only one actively tested against. You can try older versions, but there's no guarantee they'll work - Yuuko is often updated to take advantage of the latest changes to Eris.

### Development builds

All commits to Yuuko are automatically built to a separate branch to make installing development builds from Github easy. If you want to get builds from the `dev` branch, install Yuuko via `github:eritbh/yuuko#builds/dev`. Remember to grab your Eris version of choice as well.

## Usage example

```js
const {Client, Command} = require('yuuko');

const mybot = new Client({
token: 'your_bot_token', // Token used to auth your bot account
prefix: '.' // Prefix used to trigger commands
// Token used to auth your bot account
token: 'your_bot_token',
// Prefix used to trigger commands
prefix: '.',
});

const pingCommand = new Command('ping', function (msg) {
msg.channel.createMessage('Pong!')
const pingCommand = new Command('ping', message => {
message.channel.createMessage('Pong!');
});

mybot.addCommand(pingCommand).connect();
mybot
.addCommand(pingCommand)
.connect();
```

For more examples, check the [examples folder](/examples). The [documentation](https://eritbh.me/yuuko) has more information, including a complete API reference.
This is all you need to get up and running! Read the [usage guide][usage] for a walkthrough of Yuuko's most notable features, or check the [full API reference][docs].

## Development builds

All commits to Yuuko's development branches are automatically built via CI to make installing development versions from Github easy. For example, if you want to get builds from the branch `my-new-feature`, install Yuuko as `eritbh/yuuko#builds/my-new-feature`. Remember to grab your Eris version of choice as well.

## LICENSE

[MIT © eritbh](/LICENSE)

[usage]: https://eritbh.me/yuuko/usage
[docs]: https://eritbh.me/yuuko/docs
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "yuuko",
"version": "2.3.0",
"description": "A Discord bot base that I did for some reason.",
"description": "No-frills Discord command framework for Eris",
"main": "dist/Yuuko.js",
"types": "dist/Yuuko.d.ts",
"files": [
Expand Down

0 comments on commit bd5f5c1

Please sign in to comment.