Improve readme (e.g. explain JSON5 better!) #291
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
* Explain JSON5 better. Proactively emphasize that this is for config file type use cases, not machine-to-machine communication (the #1 misunderstanding or objection to JSON5). * Market/sell it better. The stats and company/project names are exciting! =) * Link to blog post. This doesn't need to be front-and-center though; just added it to my name in the credits. * Emphasize ES5 compatibility. Just put a stake in the ground here and preempt feature requests we'll never accept.
|
WDYT @jordanbtucker? I'll go ahead merge this since it's harmless and easy to iterate on post-merge too, but feedback welcome! |
|
Also see 97286f8 |
|
@aseemk Thank you for this, and sorry for taking so long to respond. Marketing is not my strong suit, so I appreciate the excellent updates to the README. My only critique is that JSON5 is technically not a strict subset of ES5 in the same way that JSON is not a strict subset of ES5—JSON5 and JSON allow U+2028 and U+2029 characters in strings while ES5 does not. |
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.
Aims to fix #285:
Explain JSON5 better. Proactively emphasize that this is for config file type use cases, not machine-to-machine communication (the
#1misunderstanding or objection to JSON5).Market/sell it better. The stats and company/project names are exciting! =)
Link to blog post. This doesn't need to be front-and-center though; just added it to my name in the credits.
Emphasize ES5 compatibility. Just put a stake in the ground here and preempt feature requests we'll never accept.