JS-SDK README cleanup/writeup/contribution #756
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update `README.md` files for accuracy and clarity. * **Root `README.md`**: - Remove outdated sections such as React demo app creation and package deletion instructions. - Add detailed tables for environment variables and error handling guides. * **Package `README.md` files**: - `packages/constants/README.md`: Improve description clarity. - `packages/core/README.md`: Add description and installation instructions. - `packages/encryption/README.md`: Improve description clarity. - `packages/lit-node-client-nodejs/README.md`: Add description, installation, usage, contributing, and license sections. - `packages/logger/README.md`: Add description and installation instructions. - `packages/misc/README.md`: Add detailed description, installation, usage, contributing, and license sections. - `packages/nacl/README.md`: Add detailed description, installation, usage, contributing, and license sections. - `packages/pkp-base/README.md`: Add detailed description, installation, usage, contributing, and license sections.
|
|
Abuchtela
commented
Jan 4, 2025
Abuchtela
commented
Jan 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update
README.mdfiles for accuracy and clarity.Root
README.md:Package
README.mdfiles:packages/constants/README.md: Improve description clarity.packages/core/README.md: Add description and installation instructions.packages/encryption/README.md: Improve description clarity.packages/lit-node-client-nodejs/README.md: Add description, installation, usage, contributing, and license sections.packages/logger/README.md: Add description and installation instructions.packages/misc/README.md: Add detailed description, installation, usage, contributing, and license sections.packages/nacl/README.md: Add detailed description, installation, usage, contributing, and license sections.packages/pkp-base/README.md: Add detailed description, installation, usage, contributing, and license sections.