<img src="https://i.imgur.com/HXwkJTF.png" alt="Goldfish Docs Logo" width="300"/>

<h2>User Documentation</h2>

Welcome to the official Goldfish User Documentation. This documentation will walk you through the setup and usage of Goldfish.

---

<h3>What is Goldfish?</h3>

Goldfish is a premium security bot for your discord server, it features a suite of security tools & features, designed to keep your server safe and secure.

We created Goldfish with the aim of making server security stress-free. No "freemium" features, or clunky webapps. Just a well-rounded security bot.

---

<h3>Getting started.</h3>

Before you can setup Goldfish in your server, you'll need an access key. You can obtain an access key by joining any of our Patreon tiers.

Occassionaly, we will release free access keys. You can obtain a free access key by joining the official Goldfish discord server.

<h4>Activating your key.</h4>

- Copy and paste your access key.
- Run the `/activate` command with your key entered.

Goldfish will now validate your key, and activate the bot. Once activated, the server will now have permanent access to Goldfish.

You can use your key to add Goldfish to an unlimited amount of servers.

<h4>Enabling your desired modules.</h4>

Goldfish features all the commands & modules you'll ever need, but you may not want all of them.

The server owner can access a control panel, which allows you to view enabled & disabled modules, and use the `/toggle` command to configure each module's status.

</h1>

---