Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

npm module needs tidying for use #288

Open
mixmix opened this issue Apr 13, 2022 · 1 comment
Open

npm module needs tidying for use #288

mixmix opened this issue Apr 13, 2022 · 1 comment
Labels
developer experience Make nicer and easier to use for developers licensing Licensing of this project and/or its dependencies

Comments

@mixmix
Copy link
Contributor

mixmix commented Apr 13, 2022

Haven't surveyed them all, but for this module : https://www.npmjs.com/package/@spruceid/didkit-wasm

It needs

  • a license - without this it's not safe to install and use
  • a homepage + repo reference
  • a readme which tells you how to use it
    • I don't need to know how to build it as the first thing I read, I want to know what API this thing has
    • you could link to your other docs over at https://spruceid.dev/docs/didkit/
@clehner clehner added developer experience Make nicer and easier to use for developers licensing Licensing of this project and/or its dependencies labels Apr 13, 2022
@clehner
Copy link
Contributor

clehner commented Apr 14, 2022

The module and its package.json are generated using wasm-pack.
To set the relevant fields (license, repository, etc), looks like would need to be done manually or by a script running after wasm-pack. Related issues: rustwasm/wasm-pack#949 rustwasm/wasm-pack#836

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer experience Make nicer and easier to use for developers licensing Licensing of this project and/or its dependencies
Projects
None yet
Development

No branches or pull requests

2 participants