Skip to content

Rewrite of the README, outsourced the settings in SETTINGS.md #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 26, 2024

Conversation

cloudmaker97
Copy link
Owner

This pull request includes significant updates to the README.md and a new SETTINGS.md file. The changes aim to improve clarity, organization, and provide detailed configuration instructions for the Discord bot.

Documentation Improvements:

  • README.md: Enhanced the description of the bot, including its purpose and the technologies used. Added a new section for terminal output and improved the formatting of the requirements and installation guide. [1] [2]
  • SETTINGS.md: Introduced a new file detailing the settings and configuration options available in config.json, including descriptions for each configurable field.

These changes are designed to make it easier for users to understand how to set up and run the bot, whether using Docker or Node.js.

@cloudmaker97 cloudmaker97 merged commit bdb80db into main Nov 26, 2024
1 check passed
@cloudmaker97 cloudmaker97 deleted the documentation/readme branch November 26, 2024 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant