Repository navigation
v2.14.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 three card games on the table and of each part of the demo (the designs, the backs, your own branding, one card, a hand, the piles, a whole table and the sounds), an Install section, an Examples section of twelve 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 pictures,docs/desktop.jpganddocs/phone.jpg;e2e/shots.mjskeeps its general pictures); 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 sections moved to pages under
docs/, each with its heading and a summary left in the README: the rules interface and the solitaires todocs/RULES-API.md; card sounds, backs, designs and your own branding todocs/CARDS.md; the card, hand, pile, embed and table elements todocs/ELEMENTS.md; the tables of every export todocs/API.md; the source tree todocs/ARCHITECTURE.md. Nothing was removed, and the tests that hold these to the code read the README and these pages together. docs/games.md,docs/strings-ja.mdanddocs/credits.mdare no longer in the tarball: the family's standard keepsdocs/out of what npm installs, and the README links them on GitHub, where they are read. The card artwork and sounds that ship are CC0 or public domain, and the README's Licence section now says which and where each came from.- The command line's help in the README names its language (
text). - Repository only: the package and everything it exports are unchanged.
CONTRIBUTING.mdis the family's one text with a section of its own for Toranpu, 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. - Source files are named in kebab-case, and a lint rule keeps them so.
- The demo's page titles read
Toranpu · pitch, like the rest of the family's. - The demo's own stylesheet is
demo/toranpu.css, named for the package like the family's.
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.