Repository navigation
v2.1.2
Nothing that was exported has changed.
Changed
- The README takes the family's one layout, fully: a hero picture of the demo on a desk and on a phone in light and dark, a picture of the world, Europe, a continent, the record, the players and the table dressed in Korokoro's dice and Toranpu's cards, an Install section, an Examples section of eleven examples whose output is what they print, and a short list of the calls to learn first. Its pictures are in
docs/images(WebP, light and dark) and are retaken withpnpm screenshots:readme(it replacespnpm picturesand the three JPEGsdocs/desktop.jpg,docs/phone.jpganddocs/dressed.jpg); they are not in the tarball, andpnpm test:packagefails if one is. - To keep the README under the 64,000 characters npm can show, the long tables of exports (playing, the map's facts, cards and dice, keeping and export, the day's seed, taps and words, the table's options and handle, the element's attributes) moved to
docs/API.md, and the source tree moved todocs/ARCHITECTURE.md, each with a summary and a link left in the README. "Dice and cards from Korokoro and Toranpu" is a section of its own, no longer under the API. Nothing was removed, and the tests that hold these tables to the code read the README anddocs/API.mdtogether. pnpm test:readmetype-checks and runs every TypeScript and JavaScript example in the README against the built package, as a CI job of its own, andpnpm checkholds the README to the family's lint.- Repository only: the package and everything it exports are unchanged.
CONTRIBUTING.mdis the family's one text with a section of its own for Tenka, held to the master in johnmorrisdotca/.github bysrc/family.test.js;ci.ymlandpages.ymlare the family's one text (pnpm check, the demo, and the package on Linux, macOS and Windows), and any jobs of the package's own after them.
Fixed
- The API reference page wraps a long entry path instead of running about 2 px wider than a 360 px screen. Nothing the package exports has changed.