NOTE: THIS REPOSITORY IS A WIP AND AS SUCH THE APIS ARE
MORE THEN LIKELY GOING TO CHANGE DRASTICALLY
A universal bot framework!~ :heart:
Docs
[![NPM Version][npm-version-image]][npm-url]
[![NPM Downloads][npm-downloads-image]][npm-url]
[![Coverage][coverage-image]][coverage-url]
[![CI Build][build-image]][build-url]
[![Code Style: Prettier][code-style-image]][code-style-url]
[![Semantic Release][semantic-release-image]][semantic-release-url]
#### Supported Platforms
- Shell _(local testing harness)_
- [Discord](https://www.npmjs.com/package/@flarie/discord)
## Install
```sh
# Install the Flarie Core
$ npm install @flarie/core
# Install any Platforms you need
$ npm install @flarie/discord
```
## Usage
```ts
import { Flarie, CampfirePlatform } from '@flarie/core';
import { DiscordPlatform } from '@flarie/discord';
const flarie = new Flarie({
platform: new DiscordPlatform({
token: ''
});,
});
```
## 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!**
[npm-version-image]: https://img.shields.io/npm/v/@flarie/core.svg
[npm-downloads-image]: https://img.shields.io/npm/dm/@flarie/core.svg
[npm-url]: https://npmjs.org/package/@flarie/core
[build-image]: https://codeberg.org/ribbon-studios/flarie/badges/workflows/ci.yml/badge.svg?branch=main
[build-url]: https://codeberg.org/ribbon-studios/flarie/actions?workflow=ci.yml&branch=main
[coverage-image]: https://ribbon-studios.codeberg.page/flarie/badge.svg
[coverage-url]: https://ribbon-studios.codeberg.page/flarie
[code-style-image]: https://img.shields.io/badge/code%20style-prettier-ff69b4.svg
[code-style-url]: https://prettier.io
[semantic-release-url]: https://github.com/semantic-release/semantic-release
[semantic-release-image]: https://img.shields.io/badge/%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079
