Commit 9074a2ce authored by Vũ Hoàng Anh's avatar Vũ Hoàng Anh

docs: remove emojis from README for a more professional look

parent 09d2da88
...@@ -4,15 +4,15 @@ ...@@ -4,15 +4,15 @@
A modern, privacy-first browser extension designed for seamless, distraction-free note-taking directly from your active web pages. Built specifically for integration with the **Memos** backend infrastructure. A modern, privacy-first browser extension designed for seamless, distraction-free note-taking directly from your active web pages. Built specifically for integration with the **Memos** backend infrastructure.
## Core Features ## Core Features
* **Lightning Fast Capture**: Highlight any text on a web page and press `Space` or `Enter` to instantly save it as a note. No context switching required. * **Lightning Fast Capture**: Highlight any text on a web page and press `Space` or `Enter` to instantly save it as a note. No context switching required.
* **🔗 Smart Source Tracking**: Automatically captures and appends the source URL and page title to your notes. * **Smart Source Tracking**: Automatically captures and appends the source URL and page title to your notes.
* **🔄 Zero-Click Authentication**: Seamlessly extracts and syncs your `memos.access-token` directly from active Canifa Note/Memos tabs. No secondary login required. * **Zero-Click Authentication**: Seamlessly extracts and syncs your `memos.access-token` directly from active Canifa Note/Memos tabs. No secondary login required.
* **🎨 Premium UI/UX**: Fully redesigned using the **shadcn/ui** design system, featuring a sleek, dark-first interface with Canifa brand aesthetics. * **Premium UI/UX**: Fully redesigned using the **shadcn/ui** design system, featuring a sleek, dark-first interface with Canifa brand aesthetics.
* **🏷️ Intelligent Tagging**: Tag notes on the fly with a smart, autocomplete-enabled chip interface. * **Intelligent Tagging**: Tag notes on the fly with a smart, autocomplete-enabled chip interface.
## 🛠️ Tech Stack ## Tech Stack
* **Framework**: React 18 * **Framework**: React 18
* **Build Tool**: Vite (optimized for Chrome Extension V3) * **Build Tool**: Vite (optimized for Chrome Extension V3)
...@@ -20,7 +20,7 @@ A modern, privacy-first browser extension designed for seamless, distraction-fre ...@@ -20,7 +20,7 @@ A modern, privacy-first browser extension designed for seamless, distraction-fre
* **Styling**: Vanilla CSS (shadcn/ui token-driven architecture) * **Styling**: Vanilla CSS (shadcn/ui token-driven architecture)
* **Backend Integration**: Native support for open-source Memos API * **Backend Integration**: Native support for open-source Memos API
## 🚀 Installation & Setup ## Installation & Setup
### Prerequisites ### Prerequisites
* Node.js 18+ * Node.js 18+
...@@ -52,14 +52,14 @@ A modern, privacy-first browser extension designed for seamless, distraction-fre ...@@ -52,14 +52,14 @@ A modern, privacy-first browser extension designed for seamless, distraction-fre
3. Click **Load unpacked**. 3. Click **Load unpacked**.
4. Select the `dist/` folder that was generated in the build step. 4. Select the `dist/` folder that was generated in the build step.
## 🎯 Usage Guide ## Usage Guide
1. **Log In to Backend**: Open your Canifa Note (Memos) instance at `http://172.16.2.210:5230/` and log in. The extension will automatically detect your session. 1. **Log In to Backend**: Open your Canifa Note (Memos) instance at `http://172.16.2.210:5230/` and log in. The extension will automatically detect your session.
2. **Highlight & Save**: On any webpage, highlight a block of text. 2. **Highlight & Save**: On any webpage, highlight a block of text.
3. **Shortcut**: Press `Space` or `Enter`. A success notification ("✓ Đã lưu vào Canifa Note") will appear, confirming your note has been saved to the server. 3. **Shortcut**: Press `Space` or `Enter`. A success notification ("✓ Đã lưu vào Canifa Note") will appear, confirming your note has been saved to the server.
4. **Manual Entry**: Click the extension icon in your browser toolbar to open the quick-entry popup. 4. **Manual Entry**: Click the extension icon in your browser toolbar to open the quick-entry popup.
## 🏗️ Project Structure ## Project Structure
```text ```text
extension/ extension/
...@@ -74,7 +74,7 @@ extension/ ...@@ -74,7 +74,7 @@ extension/
└── vite.config.ts # Vite build configuration └── vite.config.ts # Vite build configuration
``` ```
## 🔒 Security ## Security
* The extension requests the minimum required permissions (`activeTab`, `storage`, `scripting`). * The extension requests the minimum required permissions (`activeTab`, `storage`, `scripting`).
* Tokens are securely extracted locally and transmitted directly to your configured backend. * Tokens are securely extracted locally and transmitted directly to your configured backend.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment