[eCash dev libraries] Improve README for ecashjs-lib
ClosedPublic
Actions

Authored by bytesofman on Dec 13 2022, 18:31.

Details

Reviewers

Mengerian

Group Reviewers

Restricted Project

Commits

Summary

T2847

Add rev one README for ecashjs-lib. Room for improvement here, but at the moment we just need something to start from.

Test Plan

Review README.

Repository

rABC Bitcoin ABC

Branch

improve-readme-ecashjs-lib

Lint

Lint Passed

Unit

No Test Coverage

Build Status

bytesofman requested review of this revision.Dec 13 2022, 18:31

Mengerian requested changes to this revision.Dec 13 2022, 21:11

Mengerian added a subscriber: Mengerian.

Mengerian added inline comments.

web/ecashjs-lib/README.md
16 ↗	(On Diff #37257)	Could make these links relative so it doesn't depend on Github. Eg: `[Create an eCash wallet](/web/cashtab/src/hooks/useWallet.js)`

This revision now requires changes to proceed.Dec 13 2022, 21:11

bytesofman requested review of this revision.Dec 13 2022, 21:41

bytesofman added inline comments.

web/ecashjs-lib/README.md
16 ↗	(On Diff #37257)	The README in the directory with `package.json` is also what becomes the main page for the `npm` package listing. In this case, the links will be broken for users reading about the package here. https://www.npmjs.com/package/ecashjs-lib Ultimately we will link to specific examples or even additional docs in this README.