From 558bc4bb8c2279c9e2781803af7f11447645f077 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Demetrius=20Feij=C3=B3o?= <demetrius.feijoo@storyblok.com>
Date: Wed, 3 Jan 2024 18:20:02 -0300
Subject: [PATCH] docs(picker-starter): add giget instruction (#90)

* add giget instruction

* move deploy params from package.json script to workflow

* fix prettier
---
 .github/workflows/picker-starter.yml |  2 +-
 picker-starter/README.md             | 18 +++++++++++-------
 picker-starter/package.json          |  2 +-
 3 files changed, 13 insertions(+), 9 deletions(-)

diff --git a/.github/workflows/picker-starter.yml b/.github/workflows/picker-starter.yml
index 584070b..c49d6c7 100644
--- a/.github/workflows/picker-starter.yml
+++ b/.github/workflows/picker-starter.yml
@@ -45,4 +45,4 @@ jobs:
       - name: Deploy
         env:
           STORYBLOK_PERSONAL_ACCESS_TOKEN: ${{secrets.STORYBLOK_PERSONAL_ACCESS_TOKEN}}
-        run: yarn workspace picker-starter deploy --skipPrompts
+        run: yarn workspace picker-starter deploy --skipPrompts --name sb-picker-starter --scope partner-portal
diff --git a/picker-starter/README.md b/picker-starter/README.md
index beab98c..507edad 100644
--- a/picker-starter/README.md
+++ b/picker-starter/README.md
@@ -56,14 +56,20 @@ export default defineConfig((options) => {
 
 ## Local Development
 
-To start the project locally, from the **repository`s root folder**, run:
+To start using this starter locally in your project, just run:
 
 ```sh
+# copy this starter into your cwd
+npx giget@latest gh:storyblok/field-type-examples/picker-starter YOUR-PROJECT-NAME
+
+# open it
+cd YOUR-PROJECT-NAME
+
 # install all required dependencies
 yarn install
 
-# serve the field plugin
-yarn workspace picker-starter dev
+# then, serve the field plugin
+yarn dev
 ```
 
 Now open the Sandbox URL printed in your terminal:
@@ -75,10 +81,8 @@ You should see this:
 
 ## Deploy
 
-Deploy the field plugin with the [CLI](https://www.npmjs.com/package/@storyblok/field-plugin-cli). Issue a [personal access token](https://app.storyblok.com/#/me/account?tab=token), rename `.env.local.example` to `.env.example`, open the file, set the value `STORYBLOK_PERSONAL_ACCESS_TOKEN`, and run
-
-From the **repository's root folder**, run the following command:
+Deploy your field plugin with the [CLI](https://www.npmjs.com/package/@storyblok/field-plugin-cli). Issue a [personal access token](https://app.storyblok.com/#/me/account?tab=token), rename `.env.local.example` to `.env.example`, open the file, set the value `STORYBLOK_PERSONAL_ACCESS_TOKEN`, and from the **plugin's root folder**, run the following command:
 
 ```shell
-yarn workspace picker-starter deploy
+yarn deploy
 ```
diff --git a/picker-starter/package.json b/picker-starter/package.json
index 47d2c95..9c8e033 100644
--- a/picker-starter/package.json
+++ b/picker-starter/package.json
@@ -12,7 +12,7 @@
     "lint": "eslint .",
     "check:types": "vue-tsc --noEmit",
     "preview": "vite preview",
-    "deploy": "npm run build && npx @storyblok/field-plugin-cli@latest deploy --name sb-picker-starter --scope partner-portal"
+    "deploy": "npm run build && npx @storyblok/field-plugin-cli@latest deploy"
   },
   "dependencies": {
     "@storyblok/design-system": "^3.19.3",