Monorepo README

[frankhinek]

Summary

This PR replaces the Web5 JS root README file with content relevant for its current state as a monorepo.

Context

The Web5 JS Repo has gone through significant changes since its inception over 14 months and the root README had not been updated to reflect the transformation from a single NPM package to a monorepo housing 10 packages.

closes #270
closes #455

[github-actions]

TBDocs Report

🛑 Errors: 0
⚠️ Warnings: 4

@web5/api

• Project entry file: packages/api/src/index.ts

@web5/crypto

• Project entry file: packages/crypto/src/index.ts

@web5/crypto-aws-kms

• Project entry file: packages/crypto-aws-kms/src/index.ts

📄 File: ./packages/crypto-aws-kms/src/ecdsa.ts
⚠️ extractor:typedoc:missing-docs: EcdsaAlgorithm (Class) does not have any documentation.

📄 File: ./packages/crypto-aws-kms/src/key-manager.ts
⚠️ extractor:typedoc:missing-docs: AwsKeyManager (Class) does not have any documentation.

📄 File: ./packages/crypto-aws-kms/src/utils.ts
⚠️ extractor:typedoc:missing-docs: getKeySpec (CallSignature) does not have any documentation.

🔀 Misc.
⚠️ extractor:typedoc:invalid-link: Failed to resolve link to "@web5/crypto#Secp256k1.adjustSignatureToLowS | here" in comment for EcdsaAlgorithm.sign. You may have wanted "@web5/crypto!Secp256k1.adjustSignatureToLowS | here"

@web5/dids

• Project entry file: packages/dids/src/index.ts

@web5/credentials

• Project entry file: packages/credentials/src/index.ts

---

TBDocs Report Updated at 2024-04-01T23:21:53Z 2911e33

[codecov-commenter]

Codecov Report

Merging #475 (2911e33) into main (3e79652) will not change coverage.
Report is 1 commits behind head on main.
The diff coverage is n/a.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #475   +/-   ##
=======================================
  Coverage   90.54%   90.54%           
=======================================
  Files         112      112           
  Lines       29085    29085           
  Branches     2077     2077           
=======================================
  Hits        26335    26335           
  Misses       2715     2715           
  Partials       35       35           

Components	Coverage Δ
agent	78.83% <ø> (ø)
api	97.89% <ø> (ø)
common	98.68% <ø> (ø)
credentials	94.95% <ø> (ø)
crypto	93.81% <ø> (ø)
dids	97.65% <ø> (ø)
identity-agent	96.70% <ø> (ø)
crypto-aws-kms	100.00% <ø> (ø)
proxy-agent	96.70% <ø> (ø)
user-agent	96.70% <ø> (ø)

[kirahsapong]

nothing glaring and looks good!

[mistermoe]

awesome work @frankhinek