spec-feature 1.0.0 → 1.0.2

package/README.md

@@ -2,6 +2,50 @@
 
 SpecFeature is a sequential process for preparing and maintaining features: from formulating business context to verifying completed tasks. It helps synchronize product, engineering, and QA teams, reduce the number of "on-the-fly" changes, and establish success criteria before development begins. All artifacts are generated by LLM based on a single input context.
 
+## Installation
+
+### Using npx (recommended)
+
+The easiest way to use SpecFeature is through npx:
+
+```bash
+# Initialize SpecFeature in current directory
+npx spec-feature init
+
+# Initialize SpecFeature with custom folder name
+npx spec-feature init my-project-docs
+```
+
+This will create a `spec` folder (or your custom folder name) with the complete SpecFeature structure ready to use.
+
+### Global installation
+
+For frequent use, you can install SpecFeature globally:
+
+```bash
+npm install -g spec-feature
+
+# Then use it anywhere
+spec-feature init
+spec-feature init my-features
+```
+
+### Local installation
+
+To install SpecFeature in your project:
+
+```bash
+npm install spec-feature
+
+# Add to package.json scripts
+{
+  "scripts": {
+    "init-spec": "spec-feature init",
+    "init-docs": "spec-feature init documentation"
+  }
+}
+```
+
 ## Directory structure `/spec`
 
 ### Initial structure (created during initialization)

package/bin/cli.js

@@ -12,21 +12,43 @@ const command = args[0];
 
 if (command === "init") {
   const targetDir = process.cwd();
+  const folderName = args[1] || "spec"; // Use provided folder name or default to "spec"
+  const destinationDir = path.join(targetDir, folderName);
   const templatesDir = path.join(__dirname, "../spec");
 
+  function copyRecursive(src, dest) {
+    const stat = fs.statSync(src);
+    
+    if (stat.isDirectory()) {
+      if (!fs.existsSync(dest)) {
+        fs.mkdirSync(dest, { recursive: true });
+      }
+      fs.readdirSync(src).forEach(file => {
+        copyRecursive(path.join(src, file), path.join(dest, file));
+      });
+    } else {
+      fs.copyFileSync(src, dest);
+    }
+  }
+
+  // Create the destination directory if it doesn't exist
+  if (!fs.existsSync(destinationDir)) {
+    fs.mkdirSync(destinationDir, { recursive: true });
+  }
+
   fs.readdirSync(templatesDir).forEach(file => {
     const src = path.join(templatesDir, file);
-    const dest = path.join(targetDir, file);
+    const dest = path.join(destinationDir, file);
 
     if (!fs.existsSync(dest)) {
-      fs.copyFileSync(src, dest);
-      console.log(`Created file: ${file}`);
+      copyRecursive(src, dest);
+      console.log(`Created: ${folderName}/${file}`);
     } else {
-      console.log(`Skipped (already exists): ${file}`);
+      console.log(`Skipped (already exists): ${folderName}/${file}`);
     }
   });
 
-  console.log("✅ SpecFeature initialized!");
+  console.log(`✅ SpecFeature initialized in '${folderName}' folder!`);
 } else {
-  console.log("Usage: npx spec-feature init");
+  console.log("Usage: npx spec-feature init [folder-name]");
 }

package/package.json

@@ -1,8 +1,16 @@
 {
   "name": "spec-feature",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "bin": {
     "spec-feature": "./bin/cli.js"
   },
-  "type": "module"
+  "type": "module",
+  "keywords": [
+    "spec-feature",
+    "spec",
+    "feature",
+    "sdd",
+    "ai",
+    "llm"
+  ]
 }