serde-wasm-bindgen icon indicating copy to clipboard operation
serde-wasm-bindgen copied to clipboard

Spruce up the README

Open fosskers opened this issue 3 years ago • 4 comments

This PR makes the README a bit easier to read in plain text, and also replaces the large type conversion bullet-lists with charts. This makes it easier to tell what types map to what at a glance.

Note regarding some of the content in Motivation: The WASM anyref proposal seems to have been merged: https://github.com/WebAssembly/reference-types/issues/140#issue-1043423653. How does that affect this README (or project)?

fosskers avatar Dec 20 '21 18:12 fosskers

Just a heads up - this is fairly significant change, I'll take somewhat longer to get around and review it.

RReverser avatar Dec 24 '21 17:12 RReverser

The paragraphs are mostly the same, just refitted to match the usual 80-character width limit. And I moved the URLs out to make the plaintext nicer on the eyes.

Otherwise yes, the Type Tables are totally new.

fosskers avatar Dec 24 '21 19:12 fosskers

Note regarding some of the content in Motivation: The WASM anyref proposal seems to have been merged:

About this - the proposals definitely had lots of forks & renames since that was written. Now it's interface types that in theory should alleviate that cost, but I'd rather just remove that sentence altogether and not promise anything at this point :)

RReverser avatar Jan 14 '22 02:01 RReverser

I will return to this soon.

fosskers avatar Feb 25 '22 17:02 fosskers

I'm going to change the main text to what the official wasm-bindgen guide has now that serde-wasm-bindgen is the official approach, but want to keep the table and your credits, so I'll merge this PR first. Thanks for your work!

RReverser avatar Sep 07 '22 22:09 RReverser

Thanks!

fosskers avatar Sep 09 '22 06:09 fosskers