docs: improve package descriptions and standardize README formatting

- Add comprehensive package descriptions - Standardize README structure across packages - Add installation and quick start sections - Include key features and core functionality - Fix formatting issues from linter - Update root README with core systems overview Co-Authored-By: [email protected] <[email protected]>
LIT-Protocol · Jan 2, 2025 · 873aacf · 873aacf
1 parent 14b4c41
commit 873aacf
Show file tree

Hide file tree

Showing 10 changed files with 44 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -343,6 +343,28 @@ yarn graph
 
 ![](https://i.ibb.co/2dLyMTW/Screenshot-2022-11-15-at-15-18-46.png)
 
+# Core Systems and Services
+
+The Lit Protocol SDK provides the following core systems:
+
+- Cryptographic key management (PKP - Public Key Protocol)
+- Blockchain wallet interactions (Ethereum, Solana, Cosmos)
+- Decentralized authentication and authorization
+- Distributed computing and signing
+- Smart contract management
+- Access control and encryption services
+
+# Main Functions and Classes
+
+Key components available across packages:
+
+- `PKPEthersWallet`: Ethereum wallet management for PKP
+- `LitNodeClient`: Network interaction client
+- `executeJs()`: Decentralized JavaScript execution
+- `signMessageWithEncryptedKey()`: Cryptographic signing
+- `generatePrivateKey()`: Key generation utilities
+- `TinnyEnvironment`: Testing environment setup
+
 # FAQs & Common Errors
 
 <details>

diff --git a/packages/access-control-conditions/README.md b/packages/access-control-conditions/README.md
@@ -11,9 +11,9 @@ yarn add @lit-protocol/access-control-conditions
 ## Quick Start
 
 ```typescript
-import { 
+import {
   validateAccessControlConditions,
-  hashAccessControlConditions 
+  hashAccessControlConditions,
 } from '@lit-protocol/access-control-conditions';
 
 // Validate conditions

diff --git a/packages/auth-browser/README.md b/packages/auth-browser/README.md
@@ -14,10 +14,12 @@ yarn add @lit-protocol/auth-browser
 import { checkAndSignAuthMessage } from '@lit-protocol/auth-browser';
 
 // Generate an authSig with long expiration
-const expiration = new Date(Date.now() + 1000 * 60 * 60 * 24 * 30).toISOString();
+const expiration = new Date(
+  Date.now() + 1000 * 60 * 60 * 24 * 30
+).toISOString();
 const authSig = await checkAndSignAuthMessage({
   chain: 'ethereum',
-  expiration: expiration
+  expiration: expiration,
 });
 ```
 

diff --git a/packages/auth-helpers/README.md b/packages/auth-helpers/README.md
@@ -11,9 +11,9 @@ yarn add @lit-protocol/auth-helpers
 ## Quick Start
 
 ```typescript
-import { 
+import {
   encodeSessionCapabilities,
-  verifyCapabilities 
+  verifyCapabilities,
 } from '@lit-protocol/auth-helpers';
 
 // Encode session capabilities

diff --git a/packages/crypto/README.md b/packages/crypto/README.md
@@ -11,10 +11,7 @@ yarn add @lit-protocol/crypto
 ## Quick Start
 
 ```typescript
-import { 
-  generatePrivateKey,
-  encryptWithSignature 
-} from '@lit-protocol/crypto';
+import { generatePrivateKey, encryptWithSignature } from '@lit-protocol/crypto';
 
 // Generate a new private key
 const privateKey = await generatePrivateKey();

diff --git a/packages/lit-auth-client/README.md b/packages/lit-auth-client/README.md
@@ -15,7 +15,7 @@ import { LitAuthClient } from '@lit-protocol/lit-auth-client';
 
 // Initialize the auth client
 const client = new LitAuthClient({
-  redirectUri: 'https://your-app.com/callback'
+  redirectUri: 'https://your-app.com/callback',
 });
 
 // Handle social login

diff --git a/packages/pkp-base/README.md b/packages/pkp-base/README.md
@@ -36,13 +36,13 @@ const signature = await pkpBase.runLitAction(dataToSign, 'sign');
 
 ## Core Methods
 
-| Method | Description |
-| ------ | ----------- |
-| `init()` | Initialize and connect to LIT node |
-| `compressPubKey()` | Compress public keys |
-| `runLitAction()` | Execute LIT actions |
-| `createAndSetSessionSigs()` | Manage session signatures |
-| `ensureLitNodeClientReady()` | Verify node connection |
+| Method                       | Description                        |
+| ---------------------------- | ---------------------------------- |
+| `init()`                     | Initialize and connect to LIT node |
+| `compressPubKey()`           | Compress public keys               |
+| `runLitAction()`             | Execute LIT actions                |
+| `createAndSetSessionSigs()`  | Manage session signatures          |
+| `ensureLitNodeClientReady()` | Verify node connection             |
 
 ## Development
 

diff --git a/packages/pkp-ethers/README.md b/packages/pkp-ethers/README.md
@@ -25,7 +25,7 @@ const address = await wallet.getAddress();
 // Sign transaction
 const signedTx = await wallet.signTransaction({
   to: recipient,
-  value: ethers.utils.parseEther("0.1"),
+  value: ethers.utils.parseEther('0.1'),
 });
 ```
 

diff --git a/packages/pkp-walletconnect/README.md b/packages/pkp-walletconnect/README.md
@@ -20,8 +20,8 @@ const client = new PKPWalletConnect({
     name: 'Your App',
     description: 'Your app description',
     url: 'https://your-app.com',
-    icons: ['https://your-app.com/icon.png']
-  }
+    icons: ['https://your-app.com/icon.png'],
+  },
 });
 
 // Handle session proposals

diff --git a/packages/types/README.md b/packages/types/README.md
@@ -11,11 +11,11 @@ yarn add @lit-protocol/types
 ## Quick Start
 
 ```typescript
-import { 
+import {
   AccessControlConditions,
   ChainProperties,
   AuthStatus,
-  WalletProvider 
+  WalletProvider,
 } from '@lit-protocol/types';
 
 // Use types in your code