skill-100

README Template Rules

🚨 CRITICAL RULES

1. Required Sections

Every module README/USERGUIDE.md MUST include these sections in this order:

• Installation
• Usage
• Authentication
• Operations
• Examples
• Testing

Missing any section = FAIL

2. Code Example Quality

• ALL code examples MUST be working, tested TypeScript code
• Type-safe imports from the module
• Clear, explanatory comments
• Realistic but sanitized data (NO real credentials)
• Include error handling in examples

3. Never Include Real Credentials

• ALWAYS use placeholder/example values
• Mark clearly as examples: [email protected], your-password-here
• Link to credential acquisition guide
• Use .env file pattern for credential management

🟡 STANDARD RULES

Installation Section

Must include:

## Installation

\`\`\`bash
npm install @auditmation/connector-[vendor]-[service]
\`\`\`

### Prerequisites
- Node.js 14.x or higher
- npm or yarn
- Valid [Service Name] account with API access
\`\`\`

**Key elements:**
- Exact npm package name
- Node version requirements
- Any peer dependencies
- Account/permission requirements

### Usage Section

**Must include:**
1. Factory function import
2. Creating connector instance
3. Basic connection example
4. Simple operation example

**Template:**
```markdown
## Usage

### Basic Setup

\`\`\`typescript
import { newServiceName } from '@auditmation/connector-vendor-service';

// Create connector instance
const connector = newServiceName();
\`\`\`

### Connecting

\`\`\`typescript
import { ConnectionProfile } from '@auditmation/connector-vendor-service';

const profile: ConnectionProfile = {
  email: process.env.SERVICE_EMAIL!,
  password: process.env.SERVICE_PASSWORD!
  // Add other required credentials
};

const connectionState = await connector.connect(profile);
console.log('Connected! Token expires in:', connectionState.expiresIn, 'seconds');
\`\`\`

### Basic Operation

\`\`\`typescript
// Get API for specific resource
const userApi = connector.getUserApi();