codmir 0.3.0 → 0.3.1

package/README.md

@@ -27,21 +27,21 @@ npm install codmir
 or with pnpm:
 
 ```bash
-pnpm add @jobrayan/codmir
+pnpm add codmir
 ```
 
 or with yarn:
 
 ```bash
-yarn add @jobrayan/codmir
+yarn add codmir
 ```
 
 ### As a CLI (Global)
 
 ```bash
-npm install -g @jobrayan/codmir
+npm install -g codmir
 # or
-pnpm add -g @jobrayan/codmir
+pnpm add -g codmir
 ```
 
 Then authenticate and link your project:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codmir",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "TypeScript SDK for codmir API - the AI that prevents wasted engineering time",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -17,7 +17,9 @@
   },
   "files": [
     "dist",
-    "README.md"
+    "README.md",
+    "LICENSE",
+    "runkit-example.js"
   ],
   "scripts": {
     "build": "tsup src/index.ts src/cli/index.ts --format cjs,esm --dts --clean",
@@ -45,6 +47,9 @@
     "url": "https://github.com/codmir/codmir/issues"
   },
   "homepage": "https://codmir.com",
+  "runkit": {
+    "example": "runkit-example.js"
+  },
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/commit-analyzer": "^13.0.0",

package/runkit-example.js

@@ -0,0 +1,36 @@
+// RunKit example for codmir package
+// This will appear as an interactive demo on npm
+
+const { CodmirClient } = require('codmir');
+
+// Initialize the client
+const client = new CodmirClient({
+  apiKey: 'demo-api-key', // Replace with your API key
+  baseUrl: 'https://codmir.com'
+});
+
+// Example: List projects (will fail without valid API key)
+async function demo() {
+  try {
+    console.log('codmir SDK - Interactive Demo');
+    console.log('==============================\n');
+    
+    // You can try these methods with a valid API key:
+    console.log('Available methods:');
+    console.log('- client.tickets.create()');
+    console.log('- client.tickets.list()');
+    console.log('- client.tickets.update()');
+    console.log('- client.testCases.create()');
+    console.log('- client.testCases.list()');
+    console.log('\nGet your API key at: https://codmir.com/settings/tokens');
+    
+    return { 
+      message: 'codmir - the AI that prevents wasted engineering time',
+      docs: 'https://codmir.com/docs'
+    };
+  } catch (error) {
+    console.error('Error:', error.message);
+  }
+}
+
+demo();