refactor(docs): rework README #34
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The documentation for pg_idkit isn't very tight/easy to use, despite the ease of using `pgrx` and associated tooling/the extension itself. This commit improves the README by making it terser, hiding information that is unnecssary, and moving some contributor-specific details and other niche information to a `docs` folder. Signed-off-by: vados <[email protected]>
t3hmrman
force-pushed
the
refactor/docs/rework-readme
branch
from
c7a867b to
0b25b0e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation for pg_idkit isn't very tight/easy to use, despite the ease of using
pgrxand associated tooling/the extension itself.This commit improves the README by making it terser, hiding information that is unnecssary, and moving some contributor-specific details and other niche information to a
docsfolder.Resolves #14