Skip to content

Commit

Permalink
fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
Chrisae9 committed Jun 12, 2024
1 parent e18709f commit 19822b3
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 15 deletions.
17 changes: 7 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Contributing to Discord Interaction Webhook
# Contributing to Discord Interactions Webhook

We welcome contributions to the Discord Interaction Webhook project! Whether you're reporting bugs, improving the documentation, or contributing code, your help is greatly appreciated.
We welcome contributions to the Discord Interactions Webhook project! Whether you're reporting bugs, improving the documentation, or contributing code, your help is greatly appreciated.

## Table of Contents
1. [Getting Started](#getting-started)
Expand All @@ -23,23 +23,23 @@ To get started with contributing to the project, follow these steps:
1. **Fork the Repository**: Click the "Fork" button at the top right of this page to create a copy of the repository on your GitHub account.
2. **Clone Your Fork**: Clone your forked repository to your local machine:
```sh
git clone https://github.com/your-username/discord-interaction-webhook.git
git clone https://github.com/Chrisae9/discord-interactions-webhook.git
```
3. **Set Upstream Remote**: Set the original repository as the upstream remote:
```sh
cd discord-interaction-webhook
git remote add upstream https://github.com/Chrisae9/discord-interaction-webhook.git
cd discord-interactions-webhook
git remote add upstream https://github.com/Chrisae9/discord-interactions-webhook.git
```

## How to Contribute

### Reporting Bugs

If you find a bug, please report it by creating an issue in the [GitHub Issue Tracker](https://github.com/Chrisae9/discord-interaction-webhook/issues). Include as much detail as possible, including steps to reproduce the bug, the environment you're using, and any relevant log output.
If you find a bug, please report it by creating an issue in the [GitHub Issue Tracker](https://github.com/Chrisae9/discord-interactions-webhook/issues). Include as much detail as possible, including steps to reproduce the bug, the environment you're using, and any relevant log output.

### Suggesting Enhancements

If you have an idea for an enhancement or new feature, please create an issue in the [GitHub Issue Tracker](https://github.com/Chrisae9/discord-interaction-webhook/issues). Provide a clear description of the enhancement and why it would be beneficial to the project.
If you have an idea for an enhancement or new feature, please create an issue in the [GitHub Issue Tracker](https://github.com/Chrisae9/discord-interactions-webhook/issues). Provide a clear description of the enhancement and why it would be beneficial to the project.

### Contributing Code

Expand Down Expand Up @@ -94,6 +94,3 @@ Most of the setup can be inferred from the basic [README](README.md), but for lo

By contributing to this project, you agree that your contributions will be licensed under the [MIT License](LICENSE).

## Code of Conduct

Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Discord Interaction Webhook
# Discord Interactions Webhook

## Table of Contents
1. [Overview](#overview)
Expand All @@ -21,13 +21,13 @@ This application leverages Discord's Interaction API to manage Docker services v
To quickly start the application, follow these steps:

1. **Create the Project Folder**:
- Create a folder named `discord-interaction-webhook` to hold the `.env` file, the `docker-compose.yaml` file, and the `data` folder.
- Create a folder named `discord-interactions-webhook` to hold the `.env` file, the `docker-compose.yaml` file, and the `data` folder.

2. **Create and Configure `.env` File**:
- Create an application in the [Discord Developer Portal](https://discord.com/developers/applications).
- In the **General Information** tab of your application, copy the `Application ID` and `Public Key`.
- In the **Bot** tab of your application, generate a new token by clicking "Reset Token" and copy the `Bot Token`.
- Create a `.env` file in your `discord-interaction-webhook` folder with the following content:
- Create a `.env` file in your `discord-interactions-webhook` folder with the following content:

```env
APPLICATION_ID=your_discord_application_id
Expand All @@ -42,7 +42,7 @@ To quickly start the application, follow these steps:
- **Note**: You can grab Guild IDs and Role IDs by enabling developer mode in Discord settings and right-clicking on the role and server to copy their IDs. These are required for the bot to function properly and are highly recommended for security since the container has access to the Docker socket.
3. **Create Data Directory**:
- Create a `data` directory in your `discord-interaction-webhook` folder to persist data.
- Create a `data` directory in your `discord-interactions-webhook` folder to persist data.
4. **Manage Discord Commands**:
- **Pull Commands**: Populate `data/commands.json` with current commands from Discord by running:
Expand Down Expand Up @@ -115,7 +115,7 @@ To quickly start the application, follow these steps:
To build and run the application using Docker Compose, use the following steps:
1. **Create a `docker-compose.yaml` File**:
- Create a `docker-compose.yaml` file in your `discord-interaction-webhook` folder with the following content:
- Create a `docker-compose.yaml` file in your `discord-interactions-webhook` folder with the following content:
```yaml
services:
Expand Down

0 comments on commit 19822b3

Please sign in to comment.