v0.10.0 - Add a Current Limitations section to the README

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to the "test-profile" extension will be documented in this f
 
 Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
+## [0.10.0] - 2024-03-25
+
+### Changed
+
+- Added the *Current Limitations* section to the README.
+
 ## [0.9.0] - 2024-02-09
 
 ### Fixed

README.md

@@ -41,6 +41,14 @@ To be more specific, the [activation event](https://code.visualstudio.com/api/re
 | -------------------------------------------------- | ------- | ------- | ------------------------------------------------------ |
 | Profile Status: Alignment | String (enum) | "Left"   | Set the position on the status bar. Values are : "Left" and "Right".|
 
+## Current Limitations
+
+The [VS Code Extension API](https://code.visualstudio.com/api) does not have an event to indicate that the profile of the workspace has changed. Most but not all scenarios are covered by this extension because typically when you switch to another profile, the workspace is reloaded which triggers the extension to update the status bar item. The scenarios that are not covered are:
+- If you create a new, empty profile when running the command `Profiles: Create Profile` with the default settings, the profiles changes but VS Code is not reloaded;
+- If you have the same workspace open in 2 VS Code instances and switch profile in one. The profile is not updated in the other instance.
+
+If you would like the VS Code team to provide API support for this feature, you can give a 👍 on the [feature request for adding a profile change event](https://github.com/microsoft/vscode/issues/208195).
+
 ## Contribute
 
 Contributions are welcome. If you find a bug, please raise an issue. You can **consult the [FAQ section](#faq) for some common issues** that you may encounter.

package.json

@@ -6,7 +6,7 @@
   "author": {
     "name": "Rob O'Leary"
   },
-  "version": "0.9.0",
+  "version": "0.10.0",
   "preview": false,
   "engines": {
     "vscode": "^1.46.0"