search

iterative / link-check

A Node-based tool to verify if links are alive. Built to be used anywhere!
4 stars 4 forks source link

Bundling instructions #5

Open jorgeorpinel opened 3 years ago

jorgeorpinel commented 3 years ago

The REAMDE here seems to be the same as in the generated repo. Should it include bundling instructions instead?

Cc @rogermparent

rogermparent commented 3 years ago

Currently, the parent repo intentionally copies its README to the dist repo, keeping the two only lightly coupled so any commit of the parent repo is capable of generating its intended output- README and all.

It could be worth differentiating the two, but we should note that the README on the dist repo will be the one shown on the GitHub marketplace. We could treat this parent repo's README as a separate dev-only README, or alternatively keep copying the README and use a CONTRIBUTING.md in this parent repo.

rogermparent commented 3 years ago

There are also currently deployment docs, they're just at the bottom of the README.

The repo builds into two apps: one usable on the CLI and one that's deployed as a GitHub action (the submodule). This could've been done a lot better in hindsight, but I still don't have the chance to work on it. Let me know if the docs aren't sufficient and I can help fill in the gaps!