Skip to content

Update Cargo.toml, README, and CONTRIBUTING link for better documentation and accessibility 🦜🕺#32

Merged
Az107 merged 3 commits intoAz107:masterfrom
LoboGuardian:master
Apr 13, 2025
Merged

Update Cargo.toml, README, and CONTRIBUTING link for better documentation and accessibility 🦜🕺#32
Az107 merged 3 commits intoAz107:masterfrom
LoboGuardian:master

Conversation

@LoboGuardian
Copy link
Copy Markdown
Contributor

This pull request addresses several improvements to the project's documentation and accessibility. It includes the following changes:

  • Update Cargo.toml and README.md for improved documentation and structure:
    • Refined the README.md for clarity and better structure.
    • Updated Cargo.toml to ensure accurate project metadata.
    • Added the dancing parrot emoji (🦜🕺) to the README.md for a touch of fun!
  • Update link to CONTRIBUTING.md in README for improved accessibility:
    • Corrected the link to the CONTRIBUTING.md file in the README.md, ensuring that contributors can easily find and access the contribution guidelines.

These changes aim to enhance the overall user experience and make it easier for new contributors to get involved.

Commits:

  • Update Cargo.toml and README.md for improved documentation and structure.
  • Update link to CONTRIBUTING.md in README for improved accessibility.

Checklist:

  • Code follows the project's coding style guidelines.
  • Documentation has been updated accordingly.

…ure.

(And, while we're at it, let's bring back the dancing parrot emoji. 🦜 in the README. Because, why not? 🕺)

HTeaPot has been benchmarked against other popular HTTP servers, consistently demonstrating excellent metrics:

| Metric | HTeaPot | Industry Average |
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why put the table inside a code block?
This will render it as text and not as a table

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The color syntax seemed to stand out to me, but it doesn't matter, I've already returned it to the table format.

@LoboGuardian LoboGuardian requested a review from Az107 April 13, 2025 07:23
@Az107 Az107 merged commit 15d213e into Az107:master Apr 13, 2025
1 check passed
Az107 pushed a commit that referenced this pull request Apr 15, 2025
Az107 added a commit that referenced this pull request Apr 15, 2025
* Update Cargo.toml, README, and CONTRIBUTING link for better documentation and accessibility 🦜🕺 (#32)

* Update the mod in src

* Add shutdown logger

* Add the handler for shutdown

* Use libc to handle unix

* Add shutdown.rs

* Update the mod in src

* Add the handler for shutdown

* Use libc to handle unix

* Fix shutdown module compilation error

* Fix shared reference in unix

* Fix shared reference in unix

* Access the global without shared reference

* Fix temporary value errors in shutdown.rs

* Simplified exit logic in unix
Add force quiting for repeatedly ctrl+c press

* Move close logic to main thread.

* Change signal handling and add safety checks to avoid UB

* Basic implementation to force the awake of listener thread.

this will attempt to connect to itself to wake the listener and check if
the flag is set to false

* Refactor to reach scalability and security in unix sign handler

* Add setup for graceful shutdown

---------

Co-authored-by: LoboGuardian 🐺 <30099451+LoboGuardian@users.noreply.github.com>
Co-authored-by: miky-rola <mikyrola8@gmail.com>
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