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

Reflects the current state of ThrottleX #9

Merged
merged 1 commit into from
Oct 17, 2024
Merged

Conversation

neelp03
Copy link
Owner

@neelp03 neelp03 commented Oct 17, 2024

Description

This readme reflects the current state of throttlex (v1.0.0-rc1). I have also abstracted the installation and example sections which are now available in the wiki.

Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • 🚀 New feature (non-breaking change which adds functionality)
  • 🔨 Refactoring (non-breaking change which improves code readability or structure)
  • 💔 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📖 Documentation update
  • 🧹 Chore (maintenance, dependencies, etc.)

Checklist

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • I have checked my code and corrected any misspellings.
  • Any dependent changes have been merged and published in downstream modules.

Additional Information

v1.0.0-rc1 is the prerelease version (slightly stable). I have updated the readme to better reflect this state of the project.

Reflects the current state of ThrottleX
Copy link

codecov bot commented Oct 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Flag Coverage Δ
unittests 70.19% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@neelp03 neelp03 merged commit 25d3ffe into main Oct 17, 2024
2 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.

1 participant