ipfs / helia-remote-pinning

A library that helps Helia consumers pin content via the https://ipfs.github.io/pinning-services-api-spec/. Initial design at https://pl-strflt.notion.site/create-interface-API-example-for-helia-remote-pinning-library-71011845a7b9476cb95ab425bb54455c
Other
5 stars 5 forks source link

README suggestions #12

Open BigLep opened 1 year ago

BigLep commented 1 year ago

Some things coming to mind when landing at https://github.com/ipfs/helia-remote-pinning:

  1. Rather than have a "Lead Maintainer" section, just codify this in CODEOWNERS? I assume codeowners should be helia-dev.
  2. Provide some explanation for why use this package (i.e., it's a convenience wrapper for binding Helia and pinning service providing promise for when certain actions have been completed)
  3. The design document is linked in the right hand side project description. Ideally we'd like to design docs from the README.
  4. I know covered elsewhere, but link to any relevant examples.
  5. Make sure the project is linked from https://github.com/ipfs/helia for discoverability
welcome[bot] commented 1 year ago

Thank you for submitting your first issue to this repository! A maintainer will be here shortly to triage and review. In the meantime, please double-check that you have provided all the necessary information to make this process easy! Any information that can help save additional round trips is useful! We currently aim to give initial feedback within two business days. If this does not happen, feel free to leave a comment. Please keep an eye on how this issue will be labeled, as labels give an overview of priorities, assignments and additional actions requested by the maintainers:

Finally, remember to use https://discuss.ipfs.io if you just need general support.