Skip to content

Commit

Permalink
ReadMe update
Browse files Browse the repository at this point in the history
  • Loading branch information
Khaaz committed Sep 23, 2018
1 parent 7701f94 commit 9e14983
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 6 deletions.
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,33 @@
# webSPELL
A full customizable RSS bot based of the AxonCore framework.

Custom Bot made for url_-
Communautée WebSPELL (French)

Multi purpose discord bot.
- RSS feed reader (2 website, 10 min intervals)
- fun and other commands (incoming)
### Features
+ easily add/remove feeds
+ allow chosen feeds with names/images
+ allow custom feeds via URL
+ allow to mention a custom role/everyone per feed
+ only one global timer
+ custom logging and error handler, easy to maintain
+ use webhooks only, handle ratelimit via Eris

Library: Eris (Khaazz fork)

# Axoncore
### Installation

- Clone the repo
- Run `yarn install`
- Enter the necessary informations in [src/configs](https://github.com/Khaazz/webSPELL/tree/master/src/configs)
- Enter your apis in [src/modules/Rss/apis.json](https://github.com/Khaazz/webSPELL/tree/master/src/modules/Rss)
- Run `yarn pm2start`

## Axoncore
This bot was made with AxonCore Client/Base.
You can find the repo here: https://github.com/Khaazz/AxonCore
Client in development but actively maintained and modfied. Already working
Client still in development but actively maintained and modified.

## Contributions
Feel free to contribute to this project by opening Pull-Request or Issues.
Contributions are always welcome.
2 changes: 1 addition & 1 deletion src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { webhooks } from './configs/tokenConf.json';
const guildWH = { id: webhooks.guild.id, token: webhooks.guild.token };

try {
mongoose.connect('mongodb://localhost/webSpellDevDB');
mongoose.connect('mongodb://localhost/webSpellDB');
Bot.Logger.notice('Connected to webSpell DataBase.');
Bot.AxonUtils.triggerWebhook('loader', {
color: 0x008000,
Expand Down

0 comments on commit 9e14983

Please sign in to comment.