Add Hjson support > Update README.md #38
Conversation
Codecov Report
@@ Coverage Diff @@
## master #38 +/- ##
=======================================
Coverage 81.54% 81.54%
=======================================
Files 8 8
Lines 428 428
Branches 124 124
=======================================
Hits 349 349
Misses 79 79Continue to review full report at Codecov.
|
README.md
Outdated
| Hjson is a syntax extension to JSON. It is intended to be used like a user interface for humans, to read and edit before passing the JSON data to the machine. That means you can use it to parse JSON files but it is not intended as a replacement. | ||
|
|
||
| You can check Hjson's homepage at https://hjson.org to get familiar with it and you can try out it's syntax at https://hjson.org/try.html. | ||
|
|
There was a problem hiding this comment.
It would be better if you actually had links in this paragraph. Such as:
You can see the Hjson homepage and try out its syntax.
There was a problem hiding this comment.
These .md files support any features of GitHub Flavored Markdown. You're encouraged to use them. :-)
README.md
Outdated
|
|
||
| Hjson is a syntax extension to JSON. It is intended to be used like a user interface for humans, to read and edit before passing the JSON data to the machine. That means you can use it to parse JSON files but it is not intended as a replacement. | ||
|
|
||
| You can check [Hjson's homepage](https://hjson.org) to get familiar with it and you can [try out it's syntax](https://hjson.org/try.html). |
There was a problem hiding this comment.
yeah, I too know the difference, but I still make that error ALL THE TIME. That's why I'm always watching for it. ;)
There was a problem hiding this comment.
Oh ok, did not know that, thank you. But it applies only to it right?
There was a problem hiding this comment.
The way I remember is the "it is or it has" rule. If you can't stick "it is" in the place of it's, then the correct spelling is its. It's a stupid rule because English is so irregular.
README.md
Outdated
|
|
||
| Example syntax | ||
|
|
||
| ``` |
There was a problem hiding this comment.
GFM supports syntax highlighting. It doesn't appear to support HJSON but JS looks to be an improvement:
{
# specify rate in requests/second (because comments are helpful!)
rate: 1000
// prefer c-style comments?
/* feeling old fashioned? */
# did you notice that rate does not need quotes?
hey: look ma, no quotes for strings either!
# best of all
notice: []
anything: ?
# yes, commas are optional!
}There was a problem hiding this comment.
I tried that but if you use whole example it is messed up due to an apostrophe.
{
# specify rate in requests/second (because comments are helpful!)
rate: 1000
// prefer c-style comments?
/* feeling old fashioned? */
# did you notice that rate doesn't need quotes?
hey: look ma, no quotes for strings either!
# best of all
notice: []
anything: ?
# yes, commas are optional!
}There was a problem hiding this comment.
Oh, ok I see what you did there. I am going to change it.
fixes #37