Skip to content

Add examples for Maven project into README #281

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

Merged
merged 3 commits into from
Apr 1, 2025
Merged

Add examples for Maven project into README #281

merged 3 commits into from
Apr 1, 2025

Conversation

OptimumCode
Copy link
Owner

This PR adds examples of how the library can be added to the Maven project as a dependency.

Resolves #280

@OptimumCode OptimumCode added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 28, 2025
Copy link

codecov bot commented Mar 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.76%. Comparing base (5ae9fc4) to head (39b0ce9).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #281   +/-   ##
=======================================
  Coverage   90.76%   90.76%           
=======================================
  Files         137      137           
  Lines        4073     4073           
  Branches     1087     1087           
=======================================
  Hits         3697     3697           
  Misses         81       81           
  Partials      295      295           

☔ 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.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'KMP JSON schema validator'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.50.

Benchmark suite Current: 39b0ce9 Previous: 5ae9fc4 Ratio
macosX64.CommonAvgTimeBench.validateBasic ( {"objectPath":"openapi.json","schemaPath":"openapi_schema.json"} ) 5847.217865269461 us/op 3028.1100194174755 us/op 1.93
macosX64.CommonAvgTimeBench.validateBasic ( {"objectPath":"openapi-invalid.json","schemaPath":"openapi_schema.json"} ) 8127.790988617885 us/op 3797.9234993527507 us/op 2.14
macosX64.CommonAvgTimeBench.validateFlag ( {"objectPath":"openapi.json","schemaPath":"openapi_schema.json"} ) 5519.718506504066 us/op 2930.5365618138426 us/op 1.88
macosX64.CommonAvgTimeBench.validateFlag ( {"objectPath":"openapi-invalid.json","schemaPath":"openapi_schema.json"} ) 3.0075890390906386 us/op 1.9920554145869478 us/op 1.51
macosX64.CommonAvgTimeBench.validateVerbose ( {"objectPath":"openapi-invalid.json","schemaPath":"openapi_schema.json"} ) 28234.460741463416 us/op 17750.351230107524 us/op 1.59

This comment was automatically generated by workflow using github-action-benchmark.

CC: @OptimumCode

@OptimumCode OptimumCode merged commit af3429a into main Apr 1, 2025
21 checks passed
@OptimumCode OptimumCode deleted the doc/280 branch April 1, 2025 17:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhancement: Update documentation to better explain how to use library in maven project
1 participant