Skip to content

Commit b24e0fe

Browse files
committed
readme added more details
1 parent 674f7ef commit b24e0fe

2 files changed

Lines changed: 65 additions & 1 deletion

File tree

public/architecture.png

Lines changed: 1 addition & 0 deletions
Loading

readme.md

Lines changed: 64 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<img src="./public/icon/128.png" alt="BookmarkBuddy Icon" width="128" height="128">
55
</div>
66

7-
BookmarkBuddy is a powerful Chrome extension that helps you organize and manage your bookmarks efficiently. With its intuitive interface and advanced search capabilities, you'll never lose track of your saved web pages again.
7+
BookmarkBuddy is a powerful AI-based Chrome extension that helps you organize and manage your bookmarks efficiently. Leveraging artificial intelligence, it offers an intuitive interface and advanced search capabilities, ensuring you'll never lose track of your saved web pages again.
88

99
## Installation
1010

@@ -38,6 +38,69 @@ BookmarkBuddy is a powerful Chrome extension that helps you organize and manage
3838
- Results will appear instantly as you type
3939
- Search by context based query
4040

41+
## Technical Architecture
42+
43+
BookmarkBuddy leverages advanced AI to enhance bookmark management and search. Below is an overview of its architecture and data flow:
44+
45+
### Architecture Flow Chart
46+
47+
```
48+
User clicks 'Bookmark' on a webpage
49+
|
50+
v
51+
┌─────────────────────────────┐
52+
│ Page Content Captured │
53+
└─────────────────────────────┘
54+
|
55+
v
56+
┌─────────────────────────────┐
57+
│ Meta Llama-3-8B-Instruct │
58+
│ (AI Model Analysis) │
59+
└─────────────────────────────┘
60+
|
61+
v
62+
┌───────────────────────────────────────────────┐
63+
│ Extracted Details: │
64+
│ - Title │
65+
│ - Small Description │
66+
│ - Useful Links │
67+
│ - Category │
68+
│ - Similar Websites │
69+
└───────────────────────────────────────────────┘
70+
|
71+
v
72+
┌───────────────────────────────────────────────┐
73+
│ Universal Sentence Encoder (TensorFlow.js) │
74+
│ (Embeds extracted details into vectors) │
75+
└───────────────────────────────────────────────┘
76+
|
77+
v
78+
┌─────────────────────────────┐
79+
│ Store Details & Embeddings│
80+
└─────────────────────────────┘
81+
|
82+
v
83+
┌─────────────────────────────┐
84+
│ Search & Retrieval │
85+
│ (Semantic, Contextual) │
86+
└─────────────────────────────┘
87+
```
88+
89+
### How It Works
90+
91+
1. **User Action**: When a user clicks to bookmark a page, the extension sends the page content to the AI pipeline.
92+
2. **AI Analysis (Meta Llama-3-8B-Instruct)**: The page content is analyzed using the meta/llama-3-8b-instruct pretrained model. This model extracts structured details such as:
93+
- Title
94+
- Small description
95+
- Useful links
96+
- Category
97+
- Similar websites
98+
3. **Text Embedding (TensorFlow Universal Sentence Encoder)**: The extracted details are embedded into vector representations using the Universal Sentence Encoder (running offline via TensorFlow.js). These embeddings enable fast and context-aware search.
99+
4. **Data Storage**: Both the extracted details and their embeddings are stored separately for efficient retrieval and filtering.
100+
5. **Bookmark Search**: When searching, queries are embedded and matched against stored embeddings, enabling semantic and contextual search.
101+
102+
This architecture ensures BookmarkBuddy delivers smart, AI-powered bookmark management and search, all running locally in your browser for privacy and speed.
103+
41104
## Support
42105

43106
If you encounter any issues or have questions about using BookmarkBuddy:

0 commit comments

Comments
 (0)