Update README.md

README.md

@@ -9,4 +9,81 @@ app_file: app.py
 pinned: false
 ---
 
+# Bookmark Manager App
+
+Welcome to the Bookmark Manager App! This application allows you to upload your browser bookmarks, process them to extract useful information, and interact with them using a chatbot interface.
+
+## **Features**
+
+- **Upload Bookmarks**: Import an HTML file containing your browser bookmarks.
+- **Data Extraction**: Extracts URL, website name, meta tags, and ETags from each bookmark.
+- **Content Summarization**: Generates a brief summary of each bookmark's content using a free language model.
+- **Vectorization and Storage**: Vectorizes the data and stores it in a FAISS vector database for efficient retrieval.
+- **Chatbot Interaction**: Chat with your bookmarks to retrieve information based on your queries.
+- **Bookmark Management**: Edit or delete bookmarks directly within the app.
+- **Dead Link Detection**: Identifies and marks broken or dead links prominently.
+- **User-Friendly Interface**: Improved interface with pleasant styling and clickable links.
+
+## **How to Use**
+
+1. **Upload and Process Bookmarks**
+
+   - Navigate to the **"Upload and Process Bookmarks"** tab.
+   - Click on **"Upload Bookmarks HTML File"** and select your bookmarks HTML file.
+   - Click **"Process Bookmarks"** to start processing.
+   - After processing, your bookmarks will be displayed with relevant data, and dead links will be highlighted.
+
+2. **Chat with Your Bookmarks**
+
+   - Go to the **"Chat with Bookmarks"** tab.
+   - Enter a query in natural language to search your bookmarks.
+   - Click **"Send"** to get responses related to your query.
+
+3. **Manage Your Bookmarks**
+
+   - Access the **"Manage Bookmarks"** tab.
+   - Click **"Refresh Bookmark List"** to view all bookmarks.
+   - To edit a bookmark:
+     - Enter the bookmark's index number.
+     - Provide a new title and/or URL.
+     - Click **"Edit Bookmark"**.
+   - To delete a bookmark:
+     - Enter the bookmark's index number.
+     - Click **"Delete Bookmark"**.
+
+## **Requirements**
+
+- **Python Libraries**: The app uses the following Python libraries:
+  - `gradio`
+  - `beautifulsoup4`
+  - `requests`
+  - `transformers`
+  - `sentence-transformers`
+  - `faiss-cpu`
+  - `pandas`
+
+## **Models Used**
+
+- **Summarization Model**: `sshleifer/distilbart-cnn-6-6` from Hugging Face Transformers.
+- **Embedding Model**: `all-MiniLM-L6-v2` from SentenceTransformers.
+
+## **Limitations**
+
+- **Performance**: Processing a large number of bookmarks may be slow due to resource limitations.
+- **Data Persistence**: The app does not save data between sessions. All data is lost when the app restarts.
+- **Error Handling**: Basic error handling is implemented, but unexpected inputs may cause issues.
+
+## **Acknowledgments**
+
+- **Hugging Face**: For providing the models and platform to deploy the app.
+- **Open-Source Libraries**: Thanks to the contributors of the libraries used in this project.
+
+## **License**
+
+This project is open-source and available under the MIT License.
+
+---
+
+Enjoy using the Bookmark Manager App!
+
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference