diff --git a/README.md b/README.md index 779470c..9fa037e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ -# obsidian-easy-keep-view -Google Keep style view plugin for Obsidian +# Easy Keep View + +**Easy Keep View** is an Obsidian plugin that mimics the Google Keep interface, allowing you to view and manage your notes with image thumbnails and excerpts. + +![Screenshot](assets/Screenshot_20250410_035221.png) + +## Features + +- Display notes in a card-like view with titles, excerpts, and optional image thumbnails. +- Easy-to-use interface inspired by Google Keep. +- Supports dark and light themes. +- Create new notes directly from the plugin view. + +## Installation + +1. Download the latest release from the GitHub repository. +2. Install the plugin in Obsidian by going to **Settings > Community Plugins > Install Plugin** and selecting **Easy Keep View**. +3. Enable the plugin and start organizing your notes! + +## Usage + +- Once installed, you can access **Easy Keep View** from the ribbon or sidebar. +- Click on a note card to open it in a new tab, or create a new note by clicking the "+" card. + +## Configuration + +You can customize the theme mode of the plugin (light, dark, or system-based) via the plugin settings. + +## Contributing + +Feel free to fork and submit pull requests! Contributions are welcome. + +## License + +MIT License. See [LICENSE](LICENSE) for more details. diff --git a/assets/Screenshot_20250410_035221.png b/assets/Screenshot_20250410_035221.png new file mode 100644 index 0000000..cdd5e57 Binary files /dev/null and b/assets/Screenshot_20250410_035221.png differ