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

docs: improve documentation #18

Merged
merged 3 commits into from
Apr 16, 2024
Merged

docs: improve documentation #18

merged 3 commits into from
Apr 16, 2024

Conversation

tutkli
Copy link
Owner

@tutkli tutkli commented Apr 16, 2024

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Closes #

What is the new behavior?

  • Docs comments have been added to types.
  • README file has been updated with more info

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@tutkli tutkli merged commit 639d9c4 into master Apr 16, 2024
2 checks passed
@tutkli
Copy link
Owner Author

tutkli commented Apr 16, 2024

🎉 This PR is included in version 1.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@tutkli tutkli deleted the docs branch April 16, 2024 13:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant