commit 06a24c96bd5fb93608d5069c4b2960666e042c4f parent a2ef97d0ed870c27af179f12b31d19375cebaa0f Author: cyckl <firstname.lastname@example.org> Date: Tue, 6 Oct 2020 17:25:36 -0700 added README Diffstat:
1 file changed, 29 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -0,0 +1,29 @@ +# Tweeter 2 +A mock Twitter embed generator bot for Discord, now written in Go. + +## Building +1. Install Go +2. Install [discordgo](https://github.com/bwmarrin/discordgo) with `go get github.com/bwmarrin/discordgo` +3. Start the bot and pass your token to it + - `./tweeter -t <bot token>` + +## Features +- User information pasted into tweet embed (with support for nicknames) +- Randomized likes and retweets +- Accurate recreation of Discord embed +- Written in Go, I guess + +## Example +![Example of usage and embed](https://github.com/cyckl/tweeter/raw/master/img/example.png) + +## Usage +There are three available commands: + +`.t <message>` +This generates a tweet with the provided text. + +`t.about` +About embed. + +## Bugs? +Report any bugs or other odd behaviors to the Issues page and I'll try to get it all patched up. Thanks for taking a look!