From 762bab8b7546a5bb9b2bea53f0f6bb5dd2c7cb80 Mon Sep 17 00:00:00 2001 From: Louis Date: Fri, 10 May 2024 12:11:12 +0100 Subject: [PATCH] feat: update vscode readme --- js/packages/quary-extension/README.md | 61 +-------------------------- 1 file changed, 1 insertion(+), 60 deletions(-) mode change 100644 => 120000 js/packages/quary-extension/README.md diff --git a/js/packages/quary-extension/README.md b/js/packages/quary-extension/README.md deleted file mode 100644 index f1555b0d..00000000 --- a/js/packages/quary-extension/README.md +++ /dev/null @@ -1,60 +0,0 @@ -# Quary VSCode Extension - -Quary is a VSCode extension that streamlines data analysis within your editor. It allows you to organize, wrangle, and analyze data with ease, turning VSCode into a powerful data analysis workbench. - -## Features - -- **Seamless Integration**: Work with data right within VSCode. -- **Project Scaffolding**: Instantly generate a structured data project. -- **Model Visualization**: Render and visualize data models interactively. -- **Test Execution**: Run custom tests and validate your data models with built-in test suites. -- **Integrations**: Push your models and structure directly to a local SQLite database or BigQuery, allowing for collaboration and use by others. - -## Requirements - -- VSCode version 1.8 or higher. - -## Core commands - -- `quary.run`: Configure and run your Quary data project. -- `quary.runTests`: Execute tests against your data models. -- `quary.renderModel`: Visualize data models within VSCode. - ... - -## Known Issues - -There are no known issues at the moment. For any new issues, please report them on our GitHub repository. - -## Release Notes - -- Initial prerelease version. - -## Getting Started with Quary - -Quary projects consist of seeds, models, tests, sources, and custom tests. Don't be daunted by the terminology; our guide will walk you through each component. - -### Quickstart - -1. **Open the Sample Project**: Access our template repository in GitHub's VSCode instance with no account required. -2. **Install Quary**: Search for `Quary.quary` in the extensions tab and install. -3. **Run Your Project**: Use `QUARY: Run` from the command palette to start your project against a sqlite database. - -### Anatomy of a Quary Project - -- `project.yml`: Root configuration file defining tests, models, and seeds. -- `.quary.config.yaml`: Specifies build configurations and database connections. -- `seeds/`: Holds initial data from .csv files to populate the database. -- `models/`: Contains SQL-based data models for project analysis. - -### Your First Model - -Models are at the heart of Quary, letting you transform raw data into insightful analytics. For example, `shifts_by_month` helps analyze employee shifts over time. - -```sql -SELECT - employee_id, - strftime('%Y-%m', shift_date) AS shift_month, - COUNT(*) AS total_shifts -FROM q.stg_shifts -GROUP BY employee_id, shift_month -``` diff --git a/js/packages/quary-extension/README.md b/js/packages/quary-extension/README.md new file mode 120000 index 00000000..fe840054 --- /dev/null +++ b/js/packages/quary-extension/README.md @@ -0,0 +1 @@ +../../README.md \ No newline at end of file