README.md
# Hibiki
[](https://discord.gg/rmMTZue) [](https://codeclimate.com/github/ClarityMoe/hibiki/issues) [](https://codeclimate.com/github/ClarityMoe/hibiki) [](https://github.com/ClarityMoe/hibiki/releases) [](https://david-dm.org/ClarityMoe/hibiki) [](https://circleci.com/gh/ClarityMoe/hibiki) [](https://ci.appveyor.com/project/noud02/hibiki/) [](https://npmjs.com/package/hibiki) [](https://npmjs.com/package/hibiki)
A Powerful but easy to use Discord bot framework
## Installation
```bash
$ npm i hibiki --save
# Installs the framework
```
## Usage
```ts
import { Shard as Hibiki } from "hibiki";
const bot: Hibiki = new Hibiki("token", {
// ...
});
bot.connect();
bot.on("ready", () => {
bot.init();
console.log("Ready!");
});
```
More examples can be found in /examples
## Database
Run these commands to set up the database.
```bash
# Install Postgres
$ sudo pacman -S postgresql
# or
$ sudo apt-get install postgresql
# I assume you know enough about your package manager to install postgresql
# not gonna list them all, sorry
# Now follow this on how to get postgres ready for use
# https://wiki.archlinux.org/index.php/PostgreSQL#Installing_PostgreSQL
$ createdb hibiki
# Create the database, you can change 'hibiki' to whatever you want your db name to be
$ psql hibiki
# When you're in, please run the commands below this code block
```
```sql
-- Create the 'guilds' table
CREATE TABLE guilds (
id text,
prefixes text[],
name text
);
-- Create an unique index
CREATE UNIQUE INDEX IN guilds (id);
-- Create the 'users' table
CREATE TABLE users (
id text,
discriminator text,
username text,
blocked boolean
);
-- Create an unique index again
CREATE UNIQUE INDEX IN users (id);
-- Check if the tables are there
SELECT * FROM guilds;
SELECT * FROM users;
```