Enhance README and examples with updated authentication methods and configuration details. Introduce environment-based authentication as a recommended approach, add new configuration options for bulk operations, and improve error handling examples. Update basic authentication example to demonstrate both manual and environment-based methods.

Author: fortran01

README.md

@@ -31,22 +31,52 @@ TIDAL_WORKSPACE=your_workspace_name
 TIDAL_USERNAME=your_username
 TIDAL_PASSWORD=your_password
 LOG_LEVEL=info
+BULK_BATCH_SIZE=50
+BULK_CONCURRENT_BATCHES=3
+BULK_RETRY_ATTEMPTS=3
+BULK_RETRY_DELAY=1000
 ```
 
 The base URL is automatically generated as `https://{workspace}.tidal.cloud/api/v1`.
 
 ## 🚀 Quick Start
 
-### Basic Authentication and Client Setup
+### Method 1: Manual Authentication
 
 ```typescript
-import { TidalApiClient } from './src/api/client';
+import { TidalApiClient } from './src/index';
+import { loadConfig, getAuthCredentials } from './src/config/environment';
 
-const client = new TidalApiClient({ 
-  workspace: 'your-workspace' 
+// Load configuration from environment
+const config = loadConfig();
+const credentials = getAuthCredentials();
+
+const client = new TidalApiClient({
+  workspace: config.workspace,
+  baseUrl: config.baseUrl
 });
 
-await client.authenticate('username', 'password');
+// Authenticate with credentials from .env
+await client.authenticate(credentials.username, credentials.password);
+console.log(`Authenticated: ${client.isAuthenticated()}`);
+```
+
+### Method 2: Environment-based Authentication (Recommended)
+
+```typescript
+import { createAuthenticatedClient } from './src/index';
+
+// This automatically loads from environment variables
+const client = await createAuthenticatedClient();
+console.log(`Workspace: ${client.getWorkspace()}`);
+```
+
+### Basic Authentication Example
+
+Run the basic authentication example to see both methods in action:
+
+```bash
+npx ts-node examples/basic-authentication.ts
 ```
 
 ### Server Operations
@@ -55,6 +85,14 @@ For detailed examples of server operations including backup functionality, bulk
 
 ## 🎮 Examples
 
+### Basic Authentication
+
+Demonstrates both manual and environment-based authentication methods:
+
+```bash
+npx ts-node examples/basic-authentication.ts
+```
+
 ### Server Backup Demo
 
 Run the server backup demonstration:
@@ -69,6 +107,14 @@ Or run directly:
 npx ts-node examples/server-backup-demo.ts
 ```
 
+### Available Examples
+
+- `basic-authentication.ts` - Authentication methods and client setup
+- `server-backup-demo.ts` - Server backup operations
+- `hostname-to-fqdn-demo.ts` - Hostname to FQDN conversion
+- `hostname-to-tag-demo.ts` - Hostname to tag operations
+- `description-to-hostname-demo.ts` - Description to hostname mapping
+
 See the `examples/` folder for more detailed usage examples and demonstrations.
 
 ## 🧪 Testing
@@ -89,10 +135,6 @@ npm test -- --testPathPattern=backup
 
 Current test coverage: **88%** (exceeds 80% requirement)
 
-
-
-
-
 ## 🏗️ Architecture
 
 ```
@@ -122,18 +164,25 @@ tests/
 
 ## 🔍 Error Handling
 
-The client provides comprehensive error handling:
+The client provides comprehensive error handling with specific error types:
 
 ```typescript
+import { AuthenticationError, TidalApiError, ValidationError } from './src/index';
+
 try {
-  const backup = await serverOps.createServerBackup();
+  const client = await createAuthenticatedClient();
+  const response = await client.get('/servers');
 } catch (error) {
   if (error instanceof AuthenticationError) {
-    // Handle authentication issues
+    console.error('Authentication failed:', error.message);
+    // Check credentials in .env file
+  } else if (error instanceof TidalApiError) {
+    console.error('API Error:', error.message);
+    console.error(`Status: ${error.status}, Code: ${error.code}`);
   } else if (error instanceof ValidationError) {
-    // Handle validation errors
+    console.error('Validation error:', error.message);
   } else {
-    // Handle other errors
+    console.error('Unexpected error:', error);
   }
 }
 ```

examples/basic-authentication.ts

@@ -17,7 +17,6 @@
 
 import { TidalApiClient, createAuthenticatedClient } from '../src/index';
 import { AuthenticationError, TidalApiError } from '../src/utils/errors';
-import { logger } from '../src/utils/logger';
 import { loadConfig, getAuthCredentials } from '../src/config/environment';
 
 async function basicAuthenticationExample() {