Skip to content

Commit

Permalink
docs: Updated changelog and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lcox74 committed Apr 17, 2024
1 parent c03e646 commit 77e4dc5
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 39 deletions.
13 changes: 10 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,22 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [0.2.0] - 2024-04-17

### Added

- Wallet System (#16)
- Persistent Database (#14)
- Blackjack (#18)
- Trading Cards v1 (#20)
- Testing Workflow (#22)
- Blackjack Achievements (#23)
- Notify On Startup (#17)

### Changed

- Database has moved from sqlite3 to postgreSQL
- Prod database has moved from sqlite3 to postgreSQL
- Test database uses a CGO free sqlite3 driver for running unit tests

## [0.1.1] - 2024-04-10

Expand Down Expand Up @@ -47,6 +53,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Base Framework for interactiving with the Discord API
- A basic deployment system to run the Bot from tagging

[unreleased]: https://github.com/aussiebroadwan/tony/compare/v0.1.1...HEAD
[unreleased]: https://github.com/aussiebroadwan/tony/compare/v0.2.0...HEAD
[0.2.0]: https://github.com/aussiebroadwan/tony/compare/v0.1.1...v0.2.0
[0.1.1]: https://github.com/aussiebroadwan/tony/compare/v0.1.0...v0.1.1
[0.1.0]: https://github.com/aussiebroadwan/tony/releases/tag/v0.1.0
37 changes: 1 addition & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Tony - Discord Bot

> 2nd April 2024
> 17th April 2024
The Aussie BroadWAN has its own Discord bot for it's server. This is open for
development by members of the small community. This is written in [Go] for no
Expand Down Expand Up @@ -79,41 +79,6 @@ DB_PASSWORD=password
> fields with your specific bot details.

## Current Bot Features

There are only two main commands currently with Tony, the rest are application
rules that run on either specific channels or on all.

- `ping`:
Sends the user a `Pong @<user>!` message. This is only for testing.

- `ping button`: Responses with a button which the user can press for the
same functionality as the `ping` command

- `remind`:
A system to add deplayed message or reminders for users.

- `add <time> <message>`: The message to add and when to remind the user
- `del <id>`: Deletes a message, assuming the user owns the message
- `status <id>`: Get how much time is left on a reminder
- `list`: List the ID and times of all the user's reminders

The following here are Application rules and not commands. This means they run
on all messages limited to their registered channels, with the exception of
`autopin` which is registered for all channels.

- `tech-news`:
A moderation system to ensure posts being made in the `#tech-news` channel
is in a specific format.

- `rss`:
A moderation system to ensure posts being made in the `#rss` channel is in
a specifc format.

- `autopin`:
A reaction system which automatically pins messages if there are 5 or
more 📌 reacts.

[Go]: https://go.dev/
[App Commands]: https://discord.com/developers/docs/interactions/application-commands
[Discord Dev Doc]: https://discord.com/developers/docs/getting-started
Expand Down

0 comments on commit 77e4dc5

Please sign in to comment.