Merge pull request #14 from chinkan/feature/enable-sidepanel

Feature/enable sidepanel

CHANGELOG.md

@@ -0,0 +1,44 @@
+# Changelog
+
+All notable changes to WizMuse will be documented in this file.
+
+## [0.9.0] - 2024-01-20
+
+### Added
+- Side panel support for persistent note-taking
+  - New dedicated side panel interface for managing notes
+  - Toggle button in popup to open/close side panel
+  - Grid and list view options for notes display
+- Markdown editor integration
+  - Added EasyMDE for rich markdown editing experience
+  - Real-time markdown preview
+  - Support for markdown syntax highlighting
+- Build system documentation
+  - Comprehensive guide for development setup
+  - Build script documentation
+  - Development workflow instructions
+
+### Changed
+- Enhanced popup interface
+  - Added side panel toggle button
+  - Improved toolbar layout
+  - Updated icons and tooltips
+- Improved note management
+  - New grid view layout for better note organization
+  - Enhanced note editing interface
+  - Better error handling for note operations
+
+### Fixed
+- Error handling for side panel operations
+- Note persistence across browser sessions
+- UI responsiveness in different view modes
+
+### Dependencies
+- Added `easymde` package for markdown editing capabilities
+
+### Documentation
+- Added detailed build system documentation in README
+- Updated development setup instructions
+- Added new configuration options documentation
+
+[0.9.0]: https://github.com/chinkan/chrome-ext-wizmuse/releases/tag/v0.9.0

README.md

@@ -79,11 +79,33 @@ Thanks for your contribution!
 
 This project is licensed under the GNU General Public License (GPL). You can freely use, modify, and distribute this software as long as you adhere to the terms of the GPL.
 
+## Build System
+
+This project uses Rollup as its build system. The build process is configured to handle multiple entry points, optimize assets, and prepare the extension for production.
+
+### Build Scripts
+
+```bash
+npm run dev    # Start development with watch mode
+npm run build  # Build for production
+npm run clean  # Clean the dist directory
+```
+
+### Key Features
+
+- Multiple entry point bundling for popup, options, sidepanel, and other pages
+- CSS processing with PostCSS and autoprefixer
+- Code minification in production mode
+- Asset copying and management
+- Source maps in development mode
+- Live reload during development
+
 ## Copyright
 
 Copyright (c) 2024 chinkan.ai
 
 ## Acknowledgments
 
 - [youtube-transcript](https://github.com/Kakulukian/youtube-transcript) - For providing the YouTube transcript extraction functionality.
--   [Adamvleggett](https://github.com/adamvleggett) for his [drawdown](https://github.com/adamvleggett/drawdown) library.
+- [Adamvleggett](https://github.com/adamvleggett) for his [drawdown](https://github.com/adamvleggett/drawdown) library.
+- [Easy Markdown Editor](https://github.com/Ionaru/easy-markdown-editor) - For the markdown editor functionality.