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

Improve README #774

Merged
merged 1 commit into from Dec 28, 2022
Merged

Improve README #774

merged 1 commit into from Dec 28, 2022

Conversation

alamb
Copy link
Collaborator

@alamb alamb commented Dec 28, 2022

  1. Add documentation on available features
  2. Move some items to their own sections for easier discoverability

Rendered version here: https://github.com/alamb/sqlparser-rs/blob/alamb/improve_readme/README.md

@coveralls
Copy link

Pull Request Test Coverage Report for Build 3794961608

  • 0 of 1 (0.0%) changed or added relevant line in 1 file are covered.
  • 268 unchanged lines in 1 file lost coverage.
  • Overall coverage decreased (-0.01%) to 85.974%

Changes Missing Coverage Covered Lines Changed/Added Lines %
src/lib.rs 0 1 0.0%
Files with Coverage Reduction New Missed Lines %
src/lib.rs 268 10.02%
Totals Coverage Status
Change from base Build 3794845435: -0.01%
Covered Lines: 13007
Relevant Lines: 15129

💛 - Coveralls

@alamb
Copy link
Collaborator Author

alamb commented Dec 28, 2022

I am working on improving the documentation of this crate and so I am going to merge this in prior to review.

I would love any comments on these changes and will be happy to make changes as a follow on PR

cc @tustvold and @AugustoFKL

@alamb alamb merged commit 751046d into sqlparser-rs:main Dec 28, 2022
@alamb alamb deleted the alamb/improve_readme branch April 9, 2024 20:32
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.

None yet

2 participants