Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gmitch215 committed Nov 5, 2024
1 parent 9cbd19c commit 4ca549d
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,29 @@
[codemc]: https://ci.codemc.io
[docs]: https://docs.codemc.io
[license]: https://github.com/CodeMC/Bot/blob/master/LICENSE
[api]: https://github.com/CodeMC/API

# CodeMC Bot
This is the code of the CodeMC Discord bot used on the [Discord Server][discord] of [CodeMC.io][codemc].

## Purpose
The main purpose of the bot is to handle join-requests from users, which want to use the public CI of the website.

## How it works
You simply have to type `/submit <github username or url> <repository url> <message>` to submit a join request.

The first argument can either be a username to your GitHub Profile, or a direct URL to it (recommendet).
The second argument has to be URL to a repository.
The third one is a short description of why you want to join. (Due to a Discord limitation can you not use line breaks in your description).
## How it Works
You simply have to type `/submit` to submit a join request. You will be prompted with a few questions which you have to answer.

After some validation checks will the bot ask you in DMs if you actually want to submit the provided info, which you can confirm or deny.
When confirming will the bot post an entry in the `#request-access` channel of the server which a mod or admin can then review and either accept or deny.

The bot uses the [CodeMC API][api] to process, store, and implement the join requests. Depending on whether you are accepted or denied,
the bot will create you a new Jenkins and Nexus account, or it will send you a message with the reason why you were denied.

## License
This project is licensed under MIT. Please read the [LICENSE file][license] for more information.

## Links

- [CodeMC Website (CI)][codemc]
- [CodeMC API][api]
- [Documentation][docs]
- [Discord Server][discord]

0 comments on commit 4ca549d

Please sign in to comment.