Commit f0529ca

authored

docs(various): .md readability improvements (oven-sh#597)

1 parent 349eb94 commit f0529caCopy full SHA for f0529ca

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ bun is 14x faster than Next.js at hot reloading CSS.`
`36`	`36`
`37`	`37`	It times pixels instead of builds. `color-looper.zig` writes color updates and the timestamp to a css file, while simultaneously screen recording a non-headless Chromium instance. After it finishes, it OCRs the video frames and verifies the scanned timestamps against the actual data. This data measures (1) how long each update took from saving to disk up to the pixels visible on the screen and (2) what % of frames were rendered.
`38`	`38`
`39`		-The intent is to be as accurate as possible. Measuring times reported client-side is simpler, but lower accuracy since those times may not correspond to pixels on the screen and do not start from when the data was written to disk (at best, they measure when the filesystem watcher detected the update, but often not that either). `color-looper.zig` must run separately from `browser.js` or the results will be innaccurate.
	`39`	+The intent is to be as accurate as possible. Measuring times reported client-side is simpler, but lower accuracy since those times may not correspond to pixels on the screen and do not start from when the data was written to disk (at best, they measure when the filesystem watcher detected the update, but often not that either). `color-looper.zig` must run separately from `browser.js` or the results will be inaccurate.
`40`	`40`
`41`	`41`	`It works like this:`
`42`	`42`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`[TOML](https://toml.io/) is a minimal configuration file format designed to be easy for humans to read.`
`4`	`4`
`5`		`-Bun implements a TOML parser with a few tweaks designed for better interopability with INI files and with JavaScript.`
	`5`	`+Bun implements a TOML parser with a few tweaks designed for better interoperability with INI files and with JavaScript.`
`6`	`6`
`7`	`7`	`### ; and # are comments`
`8`	`8`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`# bun-macro-relay`
`2`	`2`
`3`		`-This lets you use Faceook's [Relay](https://github.com/facebook/relay) framework (GraphQL) with bun.`
	`3`	`+This lets you use Facebook's [Relay](https://github.com/facebook/relay) framework (GraphQL) with bun.`
`4`	`4`
`5`	`5`	Specifically, this implements the bun equivalent of [`babel-plugin-relay`](https://github.com/facebook/relay/tree/main/packages/babel-plugin-relay). It parses `graphql` queries, but does not compile/save them to your artifacts directory, you still need [`relay-compiler`](https://github.com/facebook/relay/tree/main/packages/relay-compiler) for that.
`6`	`6`

Comments

(0)