build(readme): add README compatibility switching during bundling

ivangabriele · Jul 16, 2023 · e50b3f1 · e50b3f1
1 parent 71446a5
commit e50b3f1
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 9 deletions.
diff --git a/.vscodeignore b/.vscodeignore
@@ -21,5 +21,7 @@ dist/test/**
 dist/**/*.js.map
 src/**
 
+!README.github.md
+
 **/*.svg
 **/*.vsix
diff --git a/README.github.md → README.dist.md b/README.github.md → README.dist.md
@@ -1,13 +1,16 @@
 <p align="center">
-  <img alt="OpenAI Forge Logo" height="128" src="assets/icons/icon.svg" />
-  <img alt="OpenAI Forge Header" width="100%" src="assets/docs/readme-header.svg" />
+  <img alt="OpenAI Forge Logo" height="128" src="assets/icons/x512.png" />
+    <h3 align="center">OpenAI Forge</h3>
+    <p align="center"><b>Visual Studio Code Extension</b></p>
 </p>
 
 ---
 
 > OpenAI Forge automates your communication between Visual Studio Code and ChatGPT 🤖.
 
-https://github.com/ivangabriele/openai-forge-vsce/assets/5957876/fbb5ba36-a9b5-4251-868c-0fa6ef1676b5
+## Screencast
+
+<video src="https://github.com/ivangabriele/openai-forge-vsce/assets/5957876/fbb5ba36-a9b5-4251-868c-0fa6ef1676b5" width="100%"></video>
 
 ## Requirements
 

diff --git a/README.md b/README.md
@@ -1,15 +1,14 @@
 <p align="center">
-  <img alt="OpenAI Forge Logo" height="128" src="assets/icons/x512.png" />
-  <hgroup>
-    <p align="center" style="color: #e52b50; font-size: 250%; linee-height: 0; margin-bottom: 0">OpenAI Forge</p>
-    <p align="center" style="font-size: 125%">Visual Studio Code Extension</p>
-  </hgroup>
+  <img alt="OpenAI Forge Logo" height="128" src="assets/icons/icon.svg" />
+  <img alt="OpenAI Forge Header" width="100%" src="assets/docs/readme-header.svg" />
 </p>
 
 ---
 
 > OpenAI Forge automates your communication between Visual Studio Code and ChatGPT 🤖.
 
+https://github.com/ivangabriele/openai-forge-vsce/assets/5957876/fbb5ba36-a9b5-4251-868c-0fa6ef1676b5
+
 ## Requirements
 
 **YOU MUST INSTALL OpenAI Forge Browser Extension or this extension can't work.**

diff --git a/package.json b/package.json
@@ -11,7 +11,8 @@
   "main": "./dist/extension.js",
   "scripts": {
     "build": "rollup -c",
-    "bundle": "yarn clean && yarn build && (rm -Rf *.vsix || true) && vsce package --yarn",
+    "build:readme": "mv ./README.md ./README.github.md && mv ./README.dist.md ./README.md",
+    "bundle": "yarn clean && yarn build && yarn build:readme && (rm -Rf *.vsix || true) && vsce package --yarn",
     "clean": "rm -Rf ./dist",
     "release": "semantic-release && vsce publish --yarn",
     "test:lint": "eslint .",