@0xflydev/labz 1.0.20 → 1.0.22

package/dist/index.js

@@ -1616,8 +1616,11 @@ async function writeProject(outputDir, result, base, templatesDir) {
   if (fs4.existsSync(pkgPath)) {
     const pkg = JSON.parse(fs4.readFileSync(pkgPath, "utf-8"));
     pkg.name = path4.basename(outputDir);
+    pkg.description = base.description || "FHEVM Smart Contract";
     fs4.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2), "utf-8");
   }
+  const readmeContent = generateBuildReadme(path4.basename(outputDir), base, result);
+  fs4.writeFileSync(path4.join(outputDir, "README.md"), readmeContent, "utf-8");
   cleanupGitkeep(outputDir);
 }
 function cleanupGitkeep(dir) {
@@ -1648,6 +1651,75 @@ function copyDirSync(src, dest) {
     }
   }
 }
+function generateBuildReadme(projectName, base, result) {
+  const contractName = result.stats.baseTemplate.charAt(0).toUpperCase() + result.stats.baseTemplate.slice(1);
+  const modules = result.stats.modulesApplied || [];
+  const lines = [];
+  lines.push(`# ${projectName}`);
+  lines.push("");
+  lines.push(`${base.description}`);
+  lines.push("");
+  lines.push("## Overview");
+  lines.push("");
+  lines.push(`Base template: **${base.name}**`);
+  if (modules.length > 0) {
+    lines.push("");
+    lines.push("### Modules Applied");
+    lines.push("");
+    for (const mod of modules) {
+      lines.push(`- ${mod}`);
+    }
+  }
+  lines.push("");
+  lines.push("## Quick Start");
+  lines.push("");
+  lines.push("```bash");
+  lines.push("# Install dependencies");
+  lines.push("npm install");
+  lines.push("");
+  lines.push("# Compile contracts");
+  lines.push("npx hardhat compile");
+  lines.push("");
+  lines.push("# Run tests");
+  lines.push("npx hardhat test");
+  lines.push("");
+  lines.push("# Deploy (local)");
+  lines.push("npx hardhat run deploy/deploy.ts");
+  lines.push("```");
+  lines.push("");
+  lines.push("## Project Structure");
+  lines.push("");
+  lines.push("```");
+  lines.push(`${projectName}/`);
+  lines.push("  contracts/");
+  lines.push(`    ${contractName}.sol`);
+  lines.push("  test/");
+  lines.push(`    ${contractName}.test.ts`);
+  lines.push("  deploy/");
+  lines.push("    deploy.ts");
+  lines.push("  hardhat.config.ts");
+  lines.push("  package.json");
+  lines.push("```");
+  lines.push("");
+  lines.push("## FHE Operations");
+  lines.push("");
+  lines.push("This contract uses encrypted data types from FHEVM:");
+  lines.push("- `euint64`, `euint32`, `ebool` - Encrypted integers and booleans");
+  lines.push("- `FHE.add`, `FHE.sub`, `FHE.mul` - Encrypted arithmetic");
+  lines.push("- `FHE.lt`, `FHE.gt`, `FHE.eq` - Encrypted comparisons");
+  lines.push("- `FHE.select` - Encrypted conditional selection");
+  lines.push("");
+  lines.push("## Resources");
+  lines.push("");
+  lines.push("- [FHEVM Documentation](https://docs.zama.ai/fhevm)");
+  lines.push("- [Lab-Z CLI](https://github.com/Farukest/Lab-Z)");
+  lines.push("");
+  lines.push("---");
+  lines.push("");
+  lines.push("Generated with [Lab-Z](https://github.com/Farukest/Lab-Z)");
+  lines.push("");
+  return lines.join("\n");
+}
 
 // src/commands/doctor.ts
 var import_commander7 = require("commander");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xflydev/labz",
-  "version": "1.0.20",
+  "version": "1.0.22",
   "description": "Lab-Z CLI - Generate composable FHEVM smart contracts",
   "author": "0xflydev",
   "license": "MIT",
@@ -22,7 +22,7 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@0xflydev/labz-core": "^1.0.3",
+    "@0xflydev/labz-core": "^1.0.4",
     "@inquirer/prompts": "^7.2.1",
     "commander": "^12.1.0",
     "chalk": "^5.3.0",