Repository navigation
docs: Rewrite the README for newcomers - #22
Merged
Merged
Conversation
Explain what JSContact is and why to use it, start with an end-to-end vCard to JSON example, introduce the model and its surprises (id maps, contexts, vCardProps), gather issues and strict modes in one table, give context for dialects and localizations, and move the RFC map and the principles to a "How it works" section. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Rewrites the README for someone who doesn't know the JSContact and vCard RFCs.
contexts/featuresinstead ofTYPE,vCardProps/vCardParams).VCardDecoder(strict: true)andVCardEncoder(validate: false).The README snippets were run against the current code.
🤖 Generated with Claude Code