Skip to content
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

Readme enhancements #5

Merged
merged 5 commits into from
Nov 5, 2023
Merged

Readme enhancements #5

merged 5 commits into from
Nov 5, 2023

Conversation

DanEdens
Copy link
Contributor

@DanEdens DanEdens commented Nov 5, 2023

#1

  • Refactored the main description to better highlight the bot's primary functionality.
  • Streamlined the features section to use bullet points and clearer descriptions.
  • Reorganized the "Getting Started" section for better readability:
  • Added distinct sections for obtaining a Telegram token, Docker usage, and native execution.
  • Improved Docker instructions with separated steps for Docker Compose and Docker CLI.
  • Enhanced the native running instructions with clearer steps.
  • Removed redundant information, such as the explanation for Python 3 dependency.
  • Fixed code blocks for better Markdown rendering.
  • Added a hyperlink to the official website of the University of Catania (UniCT).
  • Adds correct telegram version to the requirements
  • Adds a usage Section with the various command options.

This update aims to provide clearer instructions for setting up and using the Finder-UniCT bot, making it more accessible to new contributors and users.

- Refactored the main description to better highlight the bot's primary functionality.
- Streamlined the features section to use bullet points and clearer descriptions.
- Reorganized the "Getting Started" section for better readability:
  - Added distinct sections for obtaining a Telegram token, Docker usage, and native execution.
  - Improved Docker instructions with separated steps for Docker Compose and Docker CLI.
  - Enhanced the native running instructions with clearer steps.
- Removed redundant information, such as the explanation for Python 3 dependency.
- Fixed code blocks for better Markdown rendering.

This update aims to provide clearer instructions for setting up and using the Finder-UniCT bot, making it more accessible to new contributors and users.

This is an initial rewrite that will be followed with accuracy checks and details elaboration.
- Added a hyperlink to the official website of the University of Catania (UniCT).
This is required to use Dispatch and Filters
@DanEdens
Copy link
Contributor Author

DanEdens commented Nov 5, 2023

#1

@infra-blue infra-blue merged commit f7f5618 into UNICT-DMI:main Nov 5, 2023
6 checks passed
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.

2 participants