Skip to content

Commit

Permalink
Docs update (#43)
Browse files Browse the repository at this point in the history
* Update command list and style

* Update command list

* Reorder /help

* Update example

* Update CNAME
  • Loading branch information
acdvs authored Sep 11, 2024
1 parent e80fa75 commit 9cb83bb
Show file tree
Hide file tree
Showing 7 changed files with 74 additions and 40 deletions.
30 changes: 18 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,35 @@ A simple Discord bot for getting game discount info from [isthereanydeal.com](ht

## Usage

1. [Click here][invite-link] to invite the bot to your server.
1. [Click here][invite-link] to invite the bot to your server or look up "IsThereAnyDeal" on the Discord app directory.
2. Once the bot has joined, use the commands below in any channel!

## Support the Project

If you like what you see, consider helping with monthly server costs by clicking the "Sponsor" button on the repo or by following [this link][donate-link]. Any amount helps!

## Features
## Commands

### Everyone

- `/help`
Forgot the commands again?
See the ITAD API status, latest release notes, and links to report a bug or donate.
- `/deals [game]`
Gets a list of current deals for the specified game. Lookup relies on spelling, so misspellings may return nothing. If an exact match is not found, the bot will attempt to suggest something similar.
Gets a list of current deals for a game.
- `/prices [game]`
Gets a list of all prices for a game including non-deals.
- `/top [waitlisted|collected|popular]`
Gets the top most waitlisted, collected, or popular games.
- `/sellers` ![admin only][admin-only]

### Admin-only

- `/sellers`
Lists all sellers.
- `/ignoredsellers list` ![admin only][admin-only]
Lists all ignored sellers. Ignored sellers do not appear in `/deals` lists.
- `/ignoredsellers [add|remove] [seller]` ![admin only][admin-only]
Adds or removes an ignored seller. Seller must be spelled exactly as it appears in the `/sellers` command.
- `/ignoredsellers clear` ![admin only][admin-only]
- `/ignoredsellers list`
Lists all ignored sellers. Ignored sellers do not appear in `/deals` or `/prices` lists.
- `/ignoredsellers [add|remove] [seller]`
Adds or removes an ignored seller.
- `/ignoredsellers clear`
Clears all previously added ignored sellers.

![Example usage][example]
Expand All @@ -36,5 +43,4 @@ IsThereAnyDeal Lookup is licensed under the [MIT License](https://opensource.org

[invite-link]: https://discord.com/api/oauth2/authorize?client_id=722942824999288924&permissions=274877925376&scope=bot
[donate-link]: https://www.patreon.com/acdvs
[admin-only]: docs/public/images/admin_only.png
[example]: docs/public/images/example.gif
[example]: docs/public/images/example.png
2 changes: 1 addition & 1 deletion docs/CNAME
Original file line number Diff line number Diff line change
@@ -1 +1 @@
www.dealbot.gg
dealbot.acdvs.dev
60 changes: 37 additions & 23 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
<div class="name-line">
<h1 class="name">IsThereAnyDeal Lookup</h1>
<h2 class="tag">
<svg class="tag-icon" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="5" stroke="currentColor" class="w-6 h-6">
<svg class="tag-icon" fill="none" viewBox="0 0 24 24" stroke-width="5" stroke="currentColor" class="w-6 h-6">
<path stroke-linecap="round" stroke-linejoin="round" d="M3 13.5l6.75 6.75L21 4.5" />
</svg>
<span>BOT</span>
Expand Down Expand Up @@ -79,29 +79,43 @@ <h3>A simple Discord bot for getting game discount info from <a href="https://is
<div class="section row">
<img class="example" src="public/images/example.png" alt="Example result">
<div class="commands">
<div class="command">
<div class="command__title"><code>/deals [game]</code></div>
<p class="command__detail">Gets a list of current deals for the specified game. Lookup relies on spelling, so misspellings may return nothing. If an exact match is not found, the bot will attempt to suggest something similar.</p>
<div class="commands__section">
<h4 class="commands__section-title">Everyone</h4>
<div class="command">
<div class="command__title"><code>/deals <span class="arg">[game]</span></code></div>
<p class="command__detail">Gets a list of current deals for a game.</p>
</div>
<div class="command">
<div class="command__title"><code>/prices <span class="arg">[game]</span></code></div>
<p class="command__detail">Gets a list of all prices for a game including non-deals.</p>
</div>
<div class="command">
<div class="command__title"><code>/top <span class="arg">[waitlisted|collected|popular]</span></code></div>
<p class="command__detail">Gets the top most waitlisted, collected, or popular games.</p>
</div>
<div class="command">
<div class="command__title"><code>/help</code></div>
<p class="command__detail">See the ITAD API status, latest release notes, and links to report a bug or donate.</p>
</div>
</div>
<div class="command">
<div class="command__title"><code>/top [waitlisted|collected|popular]</code></div>
<p class="command__detail">Gets the top most waitlisted, collected, or popular games.</p>
</div>
<div class="command">
<div class="command__title"><code>/sellers</code></div>
<p class="command__detail">Lists all sellers.</p>
</div>
<div class="command">
<div class="command__title"><code>/ignoredsellers list</code></div>
<p class="command__detail">Lists all ignored sellers. Ignored sellers do not appear in <code>$deals</code> lists.</p>
</div>
<div class="command">
<div class="command__title"><code>/ignoredsellers [add|remove] [seller]</code></div>
<p class="command__detail">Adds or removes an ignored seller. Seller must be spelled exactly as it appears in the <code>$sellers</code> command.</p>
</div>
<div class="command">
<div class="command__title"><code>/ignoredsellers clear</code></div>
<p class="command__detail">Clears all previously added ignored sellers.</p>
<div class="commands__section">
<h4 class="commands__section-title">Admin-only</h4>
<div class="command">
<div class="command__title"><code>/sellers</code></div>
<p class="command__detail">Lists all sellers.</p>
</div>
<div class="command">
<div class="command__title"><code>/ignoredsellers list</code></div>
<p class="command__detail">Lists all ignored sellers. Ignored sellers do not appear in <code>/deals</code> or <code>/prices</code> lists.</p>
</div>
<div class="command">
<div class="command__title"><code>/ignoredsellers <span class="arg">[add|remove] [seller]</span></code></div>
<p class="command__detail">Adds or removes an ignored seller.</p>
</div>
<div class="command">
<div class="command__title"><code>/ignoredsellers clear</code></div>
<p class="command__detail">Clears all previously added ignored sellers.</p>
</div>
</div>
</div>
</div>
Expand Down
Binary file removed docs/public/images/admin_only.png
Binary file not shown.
Binary file removed docs/public/images/example.gif
Binary file not shown.
Binary file modified docs/public/images/example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 18 additions & 4 deletions docs/styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -126,17 +126,31 @@ code {
vertical-align: top;
}

.commands__section {
margin-bottom: 2rem;
}

.commands__section-title {
margin-bottom: 1rem;
}

.command {
margin-bottom: 23px;
margin-bottom: 1rem;
}

.command .command__title {
font-size: 1.4em;
.command__title {
font-size: 1rem;
margin-bottom: 5px;
margin-left: -6px;
color: #90cdff;
}

.command .arg {
font-size: 1rem;
color: #1dacff;
}

.command .command__detail {
.command__detail {
line-height: 22px;
}

Expand Down

0 comments on commit 9cb83bb

Please sign in to comment.