Zenrac / Yume-Bot

A discord bot written in Python

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Yume Bot

  • An useful bot for discord

Table of Contents

  1. About the Project
  2. Project Status
  3. Getting Started
    1. Dependencies
    2. Building
    3. Installation
    4. Usage
  4. Release Process
    1. Versioning
    2. Payload
  5. How to Get Help
  6. Further Reading
  7. Contributing
  8. License
  9. Authors
  10. Acknowledgements

About the Project

Here you can provide more details about the project

  • We provide an useful discord bot
  • We want to improve the discord community

Back to top

Project Status

We are working on an easy self deployement of the bot on Linux VPS and trying to improve the features...

Back to top

Getting Started

Let's start here

Dependencies

https://github.com/Rapptz/discord.py@rewrite#egg=discord.py

Getting the Source

This project is hosted on GitHub. You can clone this project directly using this command:

git clone https://github.com/yumenetwork/Yume-bot

Building

Instructions for how to build your project

docker-compose build

Usage

Instructions for using your project. Ways to run the program, how to include it in another project, etc.

docker-compose up -d

If your project provides an API, either provide details for usage in this document or link to the appropriate API reference documents

Back to top

Release Process

Talk about the release process. How are releases made? What cadence? How to get new releases?

Versioning

This project uses Semantic Versioning. For a list of available versions, see the repository tag list.

Payload

Back to top

How to Get Help

Provide any instructions or contact information for users who need to get further help with your project.

Contributing

Provide details about how people can contribute to your project. If you have a contributing guide, mention it here. e.g.:

We encourage public contributions! Please review CONTRIBUTING.md for details on our code of conduct and development process.

Back to top

Further Reading

Provide links to other relevant documentation here

Back to top

License

Copyright (c) 2017 Embedded Artistry LLC

This project is licensed under the MIT License - see LICENSE.md file for details.

Back to top

Authors

  • Yume - Initial work

See also the list of contributors who participated in this project.

Back to top

Acknowledgments

Provide proper credits, shoutouts, and honorable mentions here. Also provide links to relevant repositories, blog posts, or contributors worth mentioning.

Give proper credits. This could be a link to any repo which inspired you to build this project, any blogposts or links to people who contributed in this project. If you used external code, link to the original source.

Back to top

About

A discord bot written in Python

License:MIT License


Languages

Language:Python 99.7%Language:Dockerfile 0.3%