docs: update changelog and install

Author: BoxBoxJason

CHANGELOG.md

@@ -1,46 +1,108 @@
-# Change Log
-
-All notable changes to the "achievements" extension will be documented in this file.
-
-
-## [0.0.1] | 2024-11-?? - Initial release
-
-Initial release of Achievements
-
-### Added
-
-- Over 1200 achievements
-    - Git related
-    - Code related
-    - Debugging related
-    - Testing related
-    - Refactoring related
-    - Commenting related
-    - File related
-    - More...
-- Profile
-    - View your profile and completion percentage
-    - View your time spent coding
-    - Check your progressions towards achievements
-- Achievements panel
-    - View achievements
-    - View progress towards achievements
-    - View achievement descriptions
-    - Filter achievements by category
-    - Filter achievements by progress
-    - Filter achievements by name
-- Configuration
-    - Enable / disable extension
-    - Enable / disable notifications
-    - Enable / disable any type of listeners (for privacy)
-    - Define your username
-    - Select log level
-    - Select log directory
-
-- Database
-    - Database model for achievements
-    - Database model for progressions
-    - Database model for requirements
-    - Database model for database schema
-    - Migration manager for database schema
-    - Initial achievements populated in database
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [unreleased]
+
+### 🚀 Features
+
+- Add achievements creating classes
+- Create all productivity stacking templates
+- Create files stacking templates
+- Standardize points attribution
+- Add vscode specific logger module
+- Add new achievements linked constants
+- Add config manager module (specific to vscode)
+- Add separate db migrations manager module
+- Move and upgrade Achievements model
+- Create progression management model
+- Add separate database populate module
+- Add extensions commands
+- Create proper achievements workflow controller
+- Add pusheen icons
+- Add skeleton for Achievements react webview
+- Add toggle notifications command
+- Add generic AchievementRequirement SQL script
+- Upgrade achievement model
+- Upgrade Achievements controller
+- Create Achievement webview page
+- Add separate module to handle frontend requests
+- Add containers styling
+- First UI release
+- Update logger module to accept any length / type arguments
+- Fix progressions model & controller workflow
+- Add resource creation / deletion listeners
+- Add git related achievements listeners
+- Add time time tracking
+- Add webview profile section
+- UX
+- Add terminal event listeners
+- Add tab events listeners
+- Add extensions listeners
+- Add debug listeners
+- Add new file edited listeners
+- Condition listeners setup
+- Proper image packaging
+- Add creator achievements logos
+- Style using tailwindcss
+- Add git achievements icons
+- Add terminal tasks icons
+- Add files icons
+- Add debugger icons
+- Add shortcuts icons
+- Add extensions icons
+- Add productivity icons
+- Add (temporary) speaker icons
+
+### 🐛 Bug Fixes
+
+- Leave error messages in lowercase
+- Errors in some default achievements
+- Change some constants to enums & fix awarder
+- Issues fix
+
+### 💼 Other
+
+- Default vscode extension setup
+- House cleaning
+- House cleaning
+- Prepare release
+- *(deps)* Upgrade all dependencies
+- Complete build method
+
+### 🚜 Refactor
+
+- Replace Python achievements builder with typescript
+- [**breaking**] Update model to use better-sqlite3
+- Move logger module
+- Move communication / requests to proper spots
+- Yet another achievements model rework
+- [**breaking**] Rename points to EXP
+- [**breaking**] Replace terminal by tasks
+- Move settings from raw JSON to VSCode
+
+### 📚 Documentation
+
+- Add proper README
+- Add docstrings everywhere
+- Update project description
+
+### ⚡ Performance
+
+- Upgrade achievements model (100x speedup)
+- Upgrade progressions model (100x speedup)
+- Cleanup db init to iterate over StackingTemplates
+
+### 🎨 Styling
+
+- Standardize StackingTemplates
+- Apply code formatters
+
+### ⚙️ Miscellaneous Tasks
+
+- Prepare build & config for better-sqlite3
+- Housekeeping
+- *(dependabot)* Configuration
+- Add publish workflows
+
+<!-- generated by git-cliff -->

README.md

@@ -46,3 +46,15 @@ You can also access the settings by using the command `achievements.settings`.
 |`achievements.listeners.tabs`|Enable or disable tab listeners|
 |`achievements.listeners.tasks`|Enable or disable task listeners|
 |`achievements.listeners.time`|Enable or disable time tracking listeners|
+
+## Installation
+
+### From VSIX
+
+1. Download and install [Visual Studio Code](https://code.visualstudio.com/).
+2. Download and install the [Achievements Extension VSIX](https://github.com/boxboxjason/achievements/releases) from the GitHub releases page.
+3. Open Visual Studio Code. Go to the Extensions view by clicking on the Extensions icon in the Activity Bar on the side of the window or by pressing `Ctrl+Shift+X`.
+4. Click on the three-dot menu icon in the top-right corner of the Extensions view and select "Install from VSIX...".
+5. In the file dialog that appears, navigate to the location where you downloaded the Achievements Extension VSIX file, select it, and click "Open".
+6. Visual Studio Code will install the extension. Once the installation is complete, you may need to reload Visual Studio Code for the extension to be activated. You can do this by clicking the "Reload" button that appears in the Extensions view after installation or by closing and reopening Visual Studio Code.
+7. Run the command `Achievements: Show` from the Command Palette (`Ctrl+Shift+P`) to open the Achievements panel.