From 60353760eb3dad925b8971445ad07957b9dda904 Mon Sep 17 00:00:00 2001 From: Aleksandr Lozhkovoi Date: Sat, 21 Feb 2026 21:31:21 +0100 Subject: [PATCH] docs: add pre-release plugin enable instructions --- CHANGELOG.md | 2 ++ README.md | 3 +++ docs/official-release-checklist.md | 1 + docs/pre-release-enable-plugin.md | 34 ++++++++++++++++++++++++++++++ 4 files changed, 40 insertions(+) create mode 100644 docs/pre-release-enable-plugin.md diff --git a/CHANGELOG.md b/CHANGELOG.md index f762eb0..7479c7c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,8 @@ ## Unreleased +- Added pre-release enable guide (`docs/pre-release-enable-plugin.md`) with repository install and manual workspace settings options. + ## 1.10.0 - Added command namespacing with aliases in `flutter:*` form for all canonical commands. diff --git a/README.md b/README.md index b0f0248..4942786 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,9 @@ Open-source Cursor plugin for production Flutter development and testing. - `review-flutter-code` for risk-focused review with mandatory security checks. 4. Use `prepare-mobile-release` and `setup-mobile-github-pipeline` before shipping Android/iOS builds. +Pre-release install: +- If plugin is not in Marketplace yet, follow `docs/pre-release-enable-plugin.md`. + ## Value in 5 minutes ![5-minute demo flow](assets/demo-5min-flow.svg) diff --git a/docs/official-release-checklist.md b/docs/official-release-checklist.md index ed3f953..abfea12 100644 --- a/docs/official-release-checklist.md +++ b/docs/official-release-checklist.md @@ -28,6 +28,7 @@ Use this checklist before tagging a public release. - Repository description, topics, and social preview are configured. - First release tag and GitHub Release notes are prepared. - Release automation workflow exists and is documented (`.github/workflows/release-automation.yml`, `docs/release-automation.md`). +- Pre-release plugin enable instructions exist for users (`docs/pre-release-enable-plugin.md`). ## Mobile publication readiness diff --git a/docs/pre-release-enable-plugin.md b/docs/pre-release-enable-plugin.md new file mode 100644 index 0000000..0b585e6 --- /dev/null +++ b/docs/pre-release-enable-plugin.md @@ -0,0 +1,34 @@ +# Enable Plugin Before Marketplace Release + +Use this guide while the plugin is not yet published in Cursor Marketplace. + +## Option A: Install from repository in Cursor + +1. Open Cursor command/chat input. +2. Run `/add-plugin`. +3. Provide repository URL: + - `https://github.com/Wreos/flutter-cursor-plugin` +4. Confirm installation and enable the plugin. + +Notes: +- Exact UI prompts can differ by Cursor version. +- If your build does not support repository install in `/add-plugin`, use Option B. + +## Option B: Enable manually in workspace settings + +1. Ensure the plugin is available to Cursor in your environment. +2. Open or create `.cursor/settings.json` in your project. +3. Add plugin enable flag: + +```json +{ + "plugins": { + "flutter-cursor-plugin": { + "enabled": true + } + } +} +``` + +4. Reload Cursor window. +5. Verify plugin commands are available (for example `implement-flutter-feature` or `flutter:implement-flutter-feature`).