Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Epictek authored May 5, 2021
1 parent 140111e commit 14f4790
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# tldr-Discord
[![Bot Invite Link](https://img.shields.io/badge/Invite%20Bot-badge.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.com/api/oauth2/authorize?client_id=839254228736278579&permissions=0&scope=applications.commands%20bot)
----
A tldr pages bot for Discord that uses the new slash commands.
A [tldr pages](https://github.com/tldr-pages/tldr) bot for Discord that uses the new slash commands. I tried to adhear to the [v1.5 client spec](https://github.com/tldr-pages/tldr/blob/v1.5/CLIENT-SPECIFICATION.md) but may have gone astray from it due to differences between a Discord client and a command line client.

![screenshot of slash command in use](https://raw.githubusercontent.com/Epictek/tldr-Discord/master/screenshot.png)

# Todo:
Handle caches better, store for 30 days and update if package not found.
Implement language option using the locale of the guild and allow user to override.

## Self Host Guide:
1. Download latest binary from [releases](https://github.com/Epictek/tldr-Discord/releases).
Expand Down

0 comments on commit 14f4790

Please sign in to comment.