From 47592652b6f486afb77bfa7c46ee20d2e4f395a4 Mon Sep 17 00:00:00 2001 From: Bambus Control Date: Tue, 6 May 2025 22:47:52 +0200 Subject: [PATCH] Update README.md with usage info from updates --- README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/README.md b/README.md index 7eeed6c..3f3c497 100644 --- a/README.md +++ b/README.md @@ -30,3 +30,42 @@ You can also search by Unicode codepoints! alt="Search '269' mobile preview" style="width: 24em;" >

+ +## Features + +- **Fuzzy Search**: Find characters by name, codepoint, or keywords. +- **Direct Insert**: Insert characters directly into your editor. +- **Favorites & Hotkeys**: Mark frequently used characters as favorites and assign custom hotkeys for quick insertion. +- **Persistent Filters**: Configure and save filters for planes, categories, and custom sets to refine your searches. +- **Usage Statistics**: Quickly access frequently used symbols. +- **Configurable**: All settings are managed within Obsidian's settings pane. + +## Using the Plugin + +To begin using the plugin, launch the search by executing the **Search Unicode characters** command. For more convenient access, consider assigning a hotkey: + +- Navigate to **Settings → Hotkeys**. +- Find **Search Unicode characters** and assign your preferred hotkey (e.g., `Ctrl+Shift+O`). + +### Searching for Characters + +Once the search modal is open, you can find characters by typing your query. This can be a descriptive term like `arrow` or `heart`, or a specific codepoint such as `269`. + +- Use the `↑` and `↓` arrow keys to navigate through the search results. +- Press `Enter` to insert the selected character directly into your document. + +### Managing Favorites + +You can manage your favorite characters from the search modal by adding them in the plugin settings. + +- View and manage all your favorites in **Settings → Unicode Search → Favorites**. +- Assign a hotkey to any favorite character via the plugin's settings tab. This creates a new command, "Insert '\'", which can then have a hotkey assigned under **Settings → Hotkeys → Insert '\'**. + +### Filtering Characters + +Character filters help you refine which characters appear in your search results. These are configured in **Settings → Unicode Search**. + +- Toggle filters for various Unicode planes and categories. +- Define custom filters to tailor the search to your needs. +- Be aware that a default set of filters is active. If you're unable to find a specific character, it might be excluded by the current filter settings. + - Search for your character to find out it's plane/block/category, if it's missing here: