Paths

Table of Contentst

Differential D12884

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

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

Tags

None

Subscribers

Details

Reviewers

Group Reviewers

Restricted Project

Commits

rABC6862fffecd2e: [eCash dev libraries] Improve README for ecashjs-lib

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.

Diff Detail

Repository

rABC Bitcoin ABC

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

bytesofman created this revision.Dec 13 2022, 18:31

Herald added a reviewer: Restricted Project. · View Herald TranscriptDec 13 2022, 18:31

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

Harbormaster completed remote builds in B21562: Diff 37257.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.

Note, this will be rebased after this other stack lands, as 1.0.1 was created here: D12870

ok

This revision is now accepted and ready to land.Dec 13 2022, 22:45

Rebase

Harbormaster completed remote builds in B21576: Diff 37288.Dec 14 2022, 16:23

Closed by commit rABC6862fffecd2e: [eCash dev libraries] Improve README for ecashjs-lib (authored by bytesofman). · Explain WhyDec 14 2022, 16:24

This revision was automatically updated to reflect the committed changes.

bytesofman added a commit: rABC6862fffecd2e: [eCash dev libraries] Improve README for ecashjs-lib.

Revision Contents
Changeset List

Path

Size

web/

ecashjs-lib/

6 lines

21 lines

2 lines

Diff 37289

web/ecashjs-lib/CHANGELOG.md

Loading...

web/ecashjs-lib/README.md

Loading...

web/ecashjs-lib/package.json

Loading...