fix: correct the license to PIF and ship a README with the crate - #7
Merged
Conversation
Two things wrong on the published crate page. The license was MIT. It should be Pay It Forward, the same license as tish — so the LICENSE text now matches tish's and package.json says PIF. The crate manifest uses `license-file` rather than `license`, because PIF is not an SPDX identifier and an SPDX field would either be rejected or misreport the terms; that is what tish does for the same reason. And deckfile v1.2.1 published with no README at all — crates.io renders the crate page from a README inside the package and cannot reach back into the repo, so the page was blank. The crate now carries both LICENSE and README (32 files packaged, up from 30). The README is written for a Rust consumer rather than reusing the npm one: it leads with `parse()` and the typed body rows instead of `npm install` and the Tish import path, notes that `parse` never fails because a streaming host must be able to parse a partial program, and says plainly that the crate is generated and patches belong upstream.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two things wrong on the published
deckfilecrate page.License was MIT — should be PIF
Pay It Forward, the same license as tish.
LICENSEnow carries the PIF text (with this project's own copyright line) andpackage.jsonsaysPIF.The crate manifest uses
license-filerather thanlicense, because PIF isn't an SPDX identifier — an SPDX field would either be rejected by crates.io or misreport the terms. That's what tish does, for the same reason.No README at all
deckfile v1.2.1published with an empty crate page: "deckfile v1.2.3 appears to have no README.md file". crates.io renders the page from a README inside the package and can't reach back into the repo, andbuild-rust.mjsnever generated one.Both
LICENSEandREADME.mdnow ship — 32 files packaged, up from 30.The README is written for a Rust consumer rather than reusing the npm one, since they need different things:
parse()and the typedBodyRowmatch, notnpm installand the Tish import pathparsenever fails — malformed lines land inprogram.errors, because a streaming host has to parse partial programssrc/index.tish, that Rust/JS/Tish therefore agree by construction rather than by discipline, and that patches belong upstreamVerification
Takes effect on the next release; 1.2.3 keeps the blank page and MIT metadata until then.