Understood. A "real" README focuses on utility, quick context, and clear calls to action, often starting with badges and including installation steps.
Here is the complete, final version of your README.md, formatted to professional standards.
DWA Companion: Template Manager (VS Code Extension)
| Category |
Status |
| Marketplace |
[VS Code Marketplace Link (To be inserted after publishing)] |
| Version |
1.0.0 |
Goal
The primary goal of the DWA Companion extension is to streamline the start of Digital Wave Academy training projects by centralizing template access and automating initial setup tasks. This allows trainees to skip configuration and focus immediately on the learning material.
Features
1. Template Initialization (Trainee Feature)
This feature provides seamless access to all course resources stored on Cloudflare R2.
| Feature |
Description |
| Access & Selection |
Run the command DWA: Initialize a Template... to view and select from all available training templates via a quick-pick menu. |
| Automated Setup |
Downloads all template files from Cloudflare R2 into the local folder of your choice. |
| Dependency Install |
Automatically executes the necessary dependency installation command (e.g., pnpm install) in a dedicated terminal, eliminating manual setup. |
2. Template Upload (Administrator Feature)
This command is used by administrators to update and maintain the resource library.
| Feature |
Description |
| Secure Upload |
Run the command DWA: Upload a Template... to use a secured external Python script to upload a local source folder to the R2 bucket. |
| Manifest Update |
Instantly updates the templates.json manifest, making the new or updated template immediately available for all trainees. |
Requirements & Installation
1. Installation
Install the extension directly from the Visual Studio Code Marketplace.
2. Requirements for Trainees
No prerequisites are required for trainees.
3. Requirements for Administrators (Upload Feature Only)
The upload feature relies on an external Python script for secure authentication and file transfer to R2.
| Requirement |
Details |
| Python |
Python 3.x must be installed and accessible in the system PATH. |
| Dependencies |
The required Python libraries must be installed: pip install boto3 python-dotenv |
| Configuration |
A file named r2.env containing your R2 write access keys (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, etc.) must be placed at the root of the extension's execution environment. (Warning: This file must be kept secret and is not included in the public package.) |
Release Notes
1.0.0
- Initial launch of the
dwa-companion extension.
- Added the primary command for template initialization (
dwa-companion.initTemplate).
- Added the administrator command for R2 template upload (
dwa-companion.uploadTemplate) via external Python script.
[End of README.md]
