Documentation for SockoBot - A Steem bot for Discord

in utopian-io •  7 years ago  (edited)

This was a task request by the project owner @jestemkioskiem, that was posted here. The task request asked for two important documents for the Python Discord bot. Namely:

  • An updated README.md file following professional standards.
  • A full tutorial (excluding the installing of Python libraries) on how to setup and deploy SockoBot to a server, as well as guide on how to start using it. This tutorial has to be submitted in a HOW_TO_DEPLOY.md markdown file and has to have a consistent, professional format.

Details

I added documentation for the commands that weren't already documented in the README.md file. I also added a tutorial on how to create a Discord application and how to deploy the bot to your Discord server.

Components

For the README.md I added the documentation for the following commands


$convert


$delegate image.png


$sp image.png


$vote image.png


$wallet image.png


and also updated the documentation of the other commands slightly. Furhtermore I added a completely new HOW_TO_DEPLOY.md (see here) where I explain how to create a Discord application and how to deploy SockoBot to your Discord server.

Difference

As mentioned above, I added some new documentation for some of SockBot's commands (see images). You can compare the current README.md with the old version) to see the differences yourself. HOW_TO_DEPLOY.md is brand new documentation, so I can't really compare it with anything.

Links

  • The updated README.md can be found here.
  • The brand new HOW_TO_DEPLOY.md can be found here.



Posted on Utopian.io - Rewarding Open Source Contributors

Authors get paid when people like you upvote their post.
If you enjoyed what you read here, create your account today and start earning FREE STEEM!
Sort Order:  

Thank you for the contribution. It has been approved.

You can contact us on Discord.

[utopian-moderator]

Thanks!

@amosbastian, Like your contribution, upvote.

Congratulations, you were selected for a random upvote! Follow @resteemy and upvote this post to increase your chance of being upvoted again!
Read more about @resteemy here.

i feel the contribution of this post is superb

Hey @amosbastian I am @utopian-io. I have just upvoted you!

Achievements

  • You have less than 500 followers. Just gave you a gift to help you succeed!
  • Seems like you contribute quite often. AMAZING!

Community-Driven Witness!

I am the first and only Steem Community-Driven Witness. Participate on Discord. Lets GROW TOGETHER!

mooncryption-utopian-witness-gif

Up-vote this comment to grow my power and help Open Source contributions like this one. Want to chat? Join me on Discord https://discord.gg/Pc8HG9x