Skip to content

Commit 39af557

Browse files
docs: improve package descriptions in READMEs
- Add clear description of logger package's purpose and functionality - Improve WASM package description and formatting - Enhance nacl package description with its role in the ecosystem - Clarify lit-node-client-nodejs package purpose and benefits Co-Authored-By: [email protected] <[email protected]>
1 parent 412264b commit 39af557

File tree

4 files changed

+5
-7
lines changed

4 files changed

+5
-7
lines changed

packages/lit-node-client-nodejs/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Getting Started
22

3-
This `LitNodeClientNodeJs` is created solely to run on Node.js.
4-
5-
The usual `checkAndSignAuthMessage` is not included in this package, so you need to add it manually to the constructor if you decide to use it on a browser, or with any custom auth callback.
3+
This package provides a Node.js-specific implementation of the Lit Protocol client, enabling server-side applications to interact with the Lit network. It offers optimized Node.js performance while maintaining all core Lit Protocol functionality, excluding browser-specific authentication which can be manually added if needed.
64

75
```js
86
import * as LitJsSdkNodeJs from '@lit-protocol/lit-node-client-nodejs';

packages/logger/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# logger
22

3-
This library was generated with [Nx](https://nx.dev).
3+
This package provides a centralized logging utility for the Lit Protocol SDK, offering structured logging capabilities across all packages. It enables consistent log formatting, level-based filtering, and standardized error reporting throughout the Lit Protocol ecosystem.
44

55
## Building
66

packages/nacl/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Quick Start
22

3-
re-export of https://www.npmjs.com/package/nacl
3+
This package provides essential cryptographic operations for the Lit Protocol by re-exporting TweetNaCl.js (https://www.npmjs.com/package/nacl). It offers a lightweight implementation of the NaCl (pronounced "salt") cryptography library, enabling secure encryption, decryption, and digital signatures across the Lit Protocol ecosystem.
44

55
### node.js / browser
66

packages/wasm/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# WASM
22

3-
Core lit utilities implemented in `Rust` and compiled to `WebAssembly` through `wasm-pack` implementations within this package wrap the compiled implementations from `rust` and provides functionality for converting the compiled artifact to a `base64` encoded string for binding to the generated bridge. the functionality contained within this package exposes the functinoality provided from the wasm utilities.
3+
This package provides high-performance cryptographic operations for the Lit Protocol by implementing core utilities in Rust and compiling them to WebAssembly. It enables efficient cross-platform execution of critical cryptographic functions while maintaining security and performance. The package handles the compilation process through wasm-pack and provides JavaScript bindings for seamless integration.
44

5-
For information on implementations see the [rust](./rust/README.md) directory.
5+
For detailed implementation information, see the [rust](./rust/README.md) directory.
66

77
### Building
88

0 commit comments

Comments
 (0)