Skip to content

Latest commit

 

History

History
87 lines (69 loc) · 2.9 KB

README.md

File metadata and controls

87 lines (69 loc) · 2.9 KB
Raw
NOTE: THIS REPOSITORY IS A WIP AND AS SUCH THE APIS ARE
MORE THEN LIKELY GOING TO CHANGE DRASTICALLY

A universal bot framework!~ ❤️

Docs

NPM Version NPM Downloads Coveralls CI Build

Code Style: Prettier Maintainability zx-bulk-release

Supported Platforms

  • Campfire (local testing harness)
  • Discord

Install

# Install the Flarie Core
$ npm install @flarie/core
# Install any Platforms you need
$ npm install @flarie/discord

Usage

import { Flarie, CampfirePlatform } from '@flarie/core';
import { DiscordPlatform } from '@flarie/discord';

const flarie = new Flarie({
    platform: new DiscordPlatform({
      token: '<your-discord-bot-token-here>'
    });,
});

Known Issues

These are issues that we know about, but don't have a clear fix for!

There are currently no known issues, thanks for checking!