Skip to content

Commit

Permalink
Removed vendoring from GH actions, clarified README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
arcward committed Sep 14, 2024
1 parent 05ae9d2 commit ac78e14
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
3 changes: 0 additions & 3 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

name: Go

env:
GOFLAGS: '-mod=vendor'
on:
push:
branches: [ "main" ]
Expand Down Expand Up @@ -45,7 +43,6 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Set up Go
uses: actions/setup-go@v5.0.1
with:
Expand Down
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
# DisConcierge

DisConcierge is a Discord bot that allows users to interact with
OpenAI assistants via Discord slash commands.
It features a web-based admin interface, custom slash commands,
and configurable settings for enhanced user interaction.
OpenAI assistants via Discord slash commands. It also features a
web-based admin interface for configuration and monitoring.

## Features

- Discord slash commands (`/chat` and `/private`) to interact with your OpenAI assistant
- Web-based admin interface for configuration and monitoring
- User-specific settings and rate limiting (command limits per 6 hours)
and the ability to prioritize/ignore specific users)
and the ability to prioritize/ignore specific users.
- Feedback system for user responses (Discord message components that allow
users to indicate the bot's response was good/outdated/inaccurate, or to
provide specific feedback via text modal)
- Configurable logging levels
- Configurable logging levels (adjustable "live" - no restart required)
- Database logging of OpenAI API calls and Discord interactions
- Support for both **SQLite** and **PostgreSQL** databases (*Note*: SQLite
is the default, and most tested. PostgreSQL support is 'experimental')
is the default, and most tested. PostgreSQL support is experimental)

![](./disconcierge-256x256.png)

Expand Down Expand Up @@ -292,6 +291,10 @@ an admin username/password before the bot will finish starting up:

![](./docs/ui_setup.PNG)

**Note**: If your slash commands aren't showing up in Discord (after restarting
your client), you may need to register them again. This can be done in the
admin interface under "Actions" -> "Register Discord Commands".

## Usage

Once the bot is running and invited to your Discord server (or installed
Expand Down

0 comments on commit ac78e14

Please sign in to comment.