terratest 1.0.1

package/README.md

@@ -0,0 +1,78 @@
+# TerraTest
+
+TerraTest is an Infrastructure-as-Code (IaC) CLI tool that bridges the gap between your local Behavior-Driven Development (BDD) `.feature` files and GitHub. It applies principles heavily inspired by HashiCorp's Terraform to your test management workflow.
+
+With TerraTest, your `.feature` files are the single source of truth. You use `plan` and `apply` to dynamically create, link, and manage test cases, test runs, and test plans directly in GitHub Issues and GitHub Projects V2.
+
+---
+
+## 📚 Documentation
+
+We have completely overhauled our documentation to be as intuitive and comprehensive as possible. 
+
+**Start here:** 👉 **[TerraTest Documentation Portal (docs/index.md)](docs/index.md)** 👈
+
+### Quick Links
+- **[Getting Started](docs/getting-started.md)**: Installation, authentication, and your first `apply`.
+- **[Writing Tests (The DSL)](docs/writing-tests-dsl.md)**: Master the Gherkin syntax, tags, and custom fields (like `assignees` and `milestone`).
+- **[Configuration Guide](docs/configuration.md)**: Deep dive into the `terratest.json` rules.
+- **[CLI Reference](docs/cli-reference.md)**: Cheat sheet for all commands (`plan`, `apply`, `import`, etc.).
+- **[Reporting & Analytics](docs/reporting-and-analytics.md)**: Generate execution matrices and coverage reports locally.
+- **[Architecture](docs/architecture.md)**: How the AST parser, state management, and GraphQL adapters work.
+
+---
+
+## Installation
+
+You can install TerraTest directly onto your system using npm. It is distributed as a global Node.js package:
+
+```bash
+npm install -g terratest
+```
+
+> **Note:** TerraTest requires Node.js v16 or higher to be installed on your system.
+
+## Quickstart (TL;DR)
+
+1. Create a `terratest.json` configuration file at the root of your project:
+   ```json
+   {
+       "github": {
+           "owner": "MyOrg",
+           "repository": "MyRepo",
+           "tokenEnv": "GITHUB_TOKEN"
+       },
+       "scope": {
+           "testcase": {
+               "fields": [
+                   { "name": "assignees", "type": "keywords" },
+                   { "name": "priority", "type": "tags", "values": ["@high", "@medium", "@low"] }
+               ]
+           }
+       }
+   }
+   ```
+
+2. Initialize your workspace:
+   ```bash
+   terratest init
+   ```
+
+3. Write a Gherkin file (e.g., `login.case.feature`):
+   ```gherkin
+   @testcase
+   Feature: User Login
+     
+     @high
+     Scenario: Valid Login
+       * field assignees = @octocat
+       Given the user is on the login page
+   ```
+
+4. Preview the changes and apply them to GitHub:
+   ```bash
+   terratest plan
+   terratest apply
+   ```
+
+For full details, please visit our **[Documentation Portal](docs/index.md)**.