feat: adding in https support in docs

[jaredwray]

Please check if the PR fulfills these requirements

• Followed the Contributing and Code of Conduct guidelines.
• Tests for the changes have been added (for bug fixes/features) with 100% code coverage.

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
feat: adding in https support in docs

[gemini-code-assist]

Summary of Changes

Hello @jaredwray, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the project's documentation by adding a detailed section on HTTPS support. It covers various methods for enabling HTTPS, from simple auto-generation to using custom certificates and standalone certificate generation utilities, providing users with clear guidance on securing their mock HTTP servers.

Highlights

• HTTPS Documentation Added: Comprehensive documentation for HTTPS support has been added to the README, detailing how to enable it within the MockHttp server.
• Auto-Generated Certificates: The documentation now explains how to use auto-generated self-signed certificates for HTTPS by simply setting https: true.
• Custom Certificate Options: Details on customizing auto-generated certificates using certificateOptions (e.g., common name, validity, key size, alt names) are now included.
• External Certificate Support: Instructions for providing your own PEM-encoded certificate and key, either as strings or file paths, have been added.
• Standalone Certificate Generation: The README now documents utility functions (generateCertificate, generateCertificateFiles) for generating certificates independently.
• API Reference Updates: The MockHttp constructor options and properties sections have been updated to include the new https configuration and isHttps property.

Changelog

• README.md
  • Added a new top-level section titled 'HTTPS Support' to the table of contents.
  • Introduced a comprehensive guide on enabling HTTPS, including auto-generated and custom certificate configurations.
  • Provided code examples for enabling HTTPS, customizing certificate options, and supplying external certificates.
  • Documented utility functions for standalone certificate generation.
  • Included reference tables for HTTPS options and certificate options.
  • Updated the MockHttp constructor options to include the https? parameter.
  • Added https and isHttps properties to the MockHttp properties reference.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 3f0ba83b1c

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

[gemini-code-assist]

Code Review

This pull request adds documentation for the new HTTPS support feature. The documentation is comprehensive and covers various use cases. I've found a few areas in the README.md examples and reference tables that could be improved for clarity and correctness. My suggestions focus on fixing an invalid code example, ensuring examples are complete, and correcting the format in a reference table.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (05dc3e3) to head (5fec886).
⚠️ Report is 6 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #125   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           37        37           
  Lines         1044      1044           
  Branches       208       208           
=========================================
  Hits          1044      1044           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.