eduardo-olivares1 / Narwhal

A discord bot designed to alert users of important cryptocurrency movements and events.
MIT License
2 stars 1 forks source link
cryptocurrency discord-bot discord-js twitter


Narwhal

A discord bot designed to alert users of important cryptocurrency movements and events.
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Acknowledgements

About The Project

There are a plethora of discord bots available for users with a simple Google search, however it was difficult for me to find any that suited my needs so I decided to create my own. I needed a bot that could at the most basic level, alert users of important cryptocurrency movements and events.

Here's why:

This project is still currently in its early stages so some features may change or be removed depending on how useful I find them after extended use.

Built With

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

A couple of things youll need before you can have Narwhal up and running:

Installation

(Coming soon... :smile:)

Usage

All commands begin with the default "$" prefix, however this can be changed. For example:

  $somecommand arg1 arg2 ...arg

Commands

Command documentation is as follows:

$somecommand - A very cool description.

Commands:

$ping - A simple ping command to check if services are online and responding properly.

$bind - Allows a user to change the discord text channel that Narwhal is bound to.

$narwhalPrefix - Allows a user to change the prefix for Narwhal. Default is $.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements