From a401e421c397259bc76ce33c26985f38300a6109 Mon Sep 17 00:00:00 2001
From: NightStar <57443207+Night-Star04@users.noreply.github.com>
Date: Sat, 15 Jun 2024 17:31:43 +0800
Subject: [PATCH] feature: Update README, extension icon, package version to
4.2.1
---
CHANGELOG.md | 5 ++
README.md | 220 ++++++++++++++--------------------------------
SCREENSHOTS.md | 53 +++++++++++
STEEING.MD | 97 ++++++++++++++++++++
images/icon.png | Bin 16578 -> 31856 bytes
package-lock.json | 2 +-
package.json | 2 +-
7 files changed, 224 insertions(+), 155 deletions(-)
create mode 100644 SCREENSHOTS.md
create mode 100644 STEEING.MD
diff --git a/CHANGELOG.md b/CHANGELOG.md
index b5c5a71..1903d9d 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,10 @@
# ChangeLog
+## 4.2.1 (2024-06-15)
+
+1. Update the README file.
+2. Update the extension icon.
+
## 4.2.0 (2024-06-10)
1. Adjust icon misalignment.
diff --git a/README.md b/README.md
index 8127bd8..3aff2dc 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,24 @@
-# Fluent UI theme for VS Code
+
+ 
+
+
+ VS Code Fluent UI
+
+
+ A Fluent UI theme for Visual Studio Code
+
+
+ 
+ 
+
Inspired by and based on the awesome concept designs by
[u/zeealeidahmad](https://www.reddit.com/r/Windows11/comments/orbgzl/visual_studio_vs_code_and_github_desktop_with/).
+
Using CSS3 I tried as much as possible to replicate his designs. Some transparency effects are not
possible at the momend due to the current Electron version that VSCode is using.
-## Disclaimer
+## ⚠️Disclaimer⚠️
This is a workbench theme. That means that VS Code's UI is being heavily modified for aestethic
purposes only. There's no intention to enhance or compete with the original look. Is merely an
@@ -13,21 +26,31 @@ alternative. Also, please bear in mind that this theme is considered an experime
beta software, since there's no official support for this type of modification, **so used it at your
own risk**.
-# Install
+## Features
+
+- Fluent UI theme for VS Code
+- Support light/dark theme
+- Customizable accent, dark and light background colors
+- Customizable wallpaper background
+- Support Compact mode
+
+## Install
1. Run VSCode as admin.
- 1. This is important, the extension won't work otherwise
-2. Install the extension from the
- [Marketplace](https://marketplace.visualstudio.com/items?itemName=leandro-rodrigues.fluent-ui-vscode)
- 1. Optiona: Go to settings and adjust the colors (this can be done at any time)
-3. Run `> Fluent UI: Enable` and reload when prompted
+ - This is important, the extension won't work otherwise
+2. Download the latest version of the installation file from
+ [Github](https://github.com/Night-Star04/vscode-fluent-ui/releases)
+ - Optiona: Go to settings and adjust the colors (this can be done at any time)
+3. Install the extension via the `Install from VSIX` option in the extensions view
+ - You can also install it via the command line with `code --install-extension `
+4. Run `> Fluent UI: Enable` and reload when prompted
> VSCode will display a notification saying that the installtion is corrupt. That's normal, VSCode
> sees the installation as corrupt because the HTML (workbench.html) file is now changed.
>
> Just click the lil' cog on the message and select `Don't show again` and you should be good to go.
-# Uninstall
+## Uninstall
1. Run VSCode as admin.
1. This is important, you'll end up with a messed up `workbench.html` file if you run the
@@ -67,177 +90,68 @@ If you ran the command as regular user, here's how you can fix your installation