fsdcats 0.0.0-stage → 1.0.0

package/README.md

@@ -1,3 +1,63 @@
-# Temporary Holding Version
+# Fullstack Practical Exam Cheatsheet (fsdcats)
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+This package generates **clean text files (`.txt`)** containing the **step-by-step terminal setup instructions** and the **exact minimal component code** (separated by clean headers and gaps) for your Fullstack practical exam.
+
+---
+
+## 📚 Scope Covered
+
+1. **Practical 1: Vue Directives** (`v-if`, `v-else`, `v-model`, `v-show`, `v-for`, `v-on`) ➔ `practical-1.txt`
+2. **Practical 2: Data Binding (Props and Emits)** (Parent-to-Child & Child-to-Parent) ➔ `practical-2.txt`
+3. **Practical 3: Document Upload & Preview (Vue 3 + Express + Multer)** ➔ `practical-3.txt`
+4. **Practical 4: Localized State Management (Pinia Multi-Step Form)** ➔ `practical-4.txt`
+5. **Practical 5: Routing in Nuxt and Shared Layouts** (`pages/`, `[id].vue`, `layouts/default.vue`) ➔ `practical-5.txt`
+6. **CRUD Operations: Express + Mongoose REST API** (Create, Read, Update, Delete) ➔ `practical-crud.txt`
+
+---
+
+## ⚡ How to Use fsdcats
+
+Whenever you run the command for any practical, **a formatted `.txt` file is generated and automatically opened in your text editor**.
+
+### 1. Generate via npx (Zero Installation)
+```bash
+npx fsdcats 1       # Generates & opens practical-1.txt
+npx fsdcats 2       # Generates & opens practical-2.txt
+npx fsdcats 3       # Generates & opens practical-3.txt
+npx fsdcats 4       # Generates & opens practical-4.txt
+npx fsdcats 5       # Generates & opens practical-5.txt
+npx fsdcats crud    # Generates & opens practical-crud.txt
+npx fsdcats all     # Generates ALL practical text files at once!
+```
+
+### 2. Interactive Menu
+Just run:
+```bash
+npx fsdcats
+```
+And select a number from `1` to `5`, `crud`, or `all`.
+
+---
+
+## 📄 Structure of the Generated Text Files
+
+Each generated `.txt` file contains:
+1. **SECTION 1: STEP-BY-STEP PROJECT SETUP**
+   - Exact terminal commands (`npm create vue@latest ...`, `cd ...`, `npm install`, `npm run dev`).
+   - Every single prompt choice (e.g. selecting `No` for TypeScript, ESLint, Prettier to avoid exam errors).
+2. **SECTION 2: COMPONENT CODE FILES**
+   - Clearly separated by visible spacing/gaps.
+   - Component Name & target file path (e.g., `COMPONENT NAME: App.vue`, `TARGET PATH: src/App.vue`).
+   - Clean, minimal code ready to copy-paste.
+
+---
+
+## 🚀 How to Publish to npm
+
+In your terminal (inside `/Users/spare/Downloads/fullstack`), run:
+```bash
+npm publish --access public --otp=YOUR_6_DIGIT_OTP
+```
+*(Replace `YOUR_6_DIGIT_OTP` with the active code from your authenticator app).*
+
+Once published, you or your friends can run `npx fsdcats 1` on **any computer in the world**!