diff --git a/README.md b/README.md index 16282eeb..a8e44934 100644 --- a/README.md +++ b/README.md @@ -10,18 +10,20 @@ Welcome to the GitHub repository of BangNavigator, a privacy-centric search and BangNavigator is packed with a variety of features aimed at improving usability and maintaining privacy: -- **Cross-Platform Support**: Developed using Flutter, ensuring a consistent and smooth experience on both Android and iOS. -- **Native Browser Engine**: Utilizes the native browser engine of the device for optimal performance and compatibility. - **Privacy by Default**: Incognito mode is enabled by default to keep your searches and browsing history private. -- **Full Browser Functionality**: Includes all the essential features of a basic browser to browse the web efficiently. -- **Kagi Integration**: Seamlessly integrates Kagi's search, assistant, and summarizer tools within a user-friendly interface. -- **Easy Sharing**: Share URLs or text from any app directly into BangNavigator without the need to copy and paste, for direct use with summarizer/assistant. -- **Quick Summarization**: Long press any link on a website to get a summary via Kagi's summarizer. -- **Enhanced Text Interaction**: Custom context menu allows for easy passage of marked text to Kagi's search or assistant tools. -- **Home Widget**: Includes a home screen widget for quick actions, enhancing productivity. -- **Speech Input**: Supports voice commands for hands-free operation and accessibility. -- **PDF processing**: Open and directly summarize/prompt PDF documents. -- **Chat Archive**: Easily archive conversations with the Kagi assistant on your device +- **[Kagi Integration](./wiki/Kagi-Tools)**: Seamlessly integrates Kagi's search, assistant, and summarizer tools within a user-friendly interface. +- **[Easy Sharing](./wiki/Kagi-Tools)**: Share URLs or text from any app directly into BangNavigator without the need to copy and paste, for direct use with summarizer/assistant. +- **[Quick Summarization](./wiki/Browser)**: Long press any link on a website to get a summary via Kagi's summarizer. +- **[Enhanced Text Interaction](./wiki/Browser)**: Custom context menu allows for easy passage of marked text to Kagi's search or assistant tools. +- **[Home Widget](./wiki/Home-Widget)**: Includes a home screen widget for quick actions, enhancing productivity. +- **[Speech Input](./wiki/Kagi-Tools)**: Supports voice commands for hands-free operation and accessibility. +- **[PDF processing](./wiki/Kagi-Tools)**: Open and directly summarize/prompt PDF documents. +- **[Chat Archive](./wiki/Chat-Archive)**: Easily archive conversations with the Kagi assistant on your device and search through them locally +- **[Bang Repository](./wiki/Bangs)**: Automatically synchronizes all official Kagi Bangs from the official Repository and makes them available through a convenient interface. + +## Getting started + +Head over to the [wiki](./wiki/Quickstart-Guide) to learn how to set up the app and explore its features. ## Notice: Seeking Test Users for App Launch on Google Play @@ -55,57 +57,3 @@ If you are interested in being a part of this testing phase, please follow these Please send the email address of your Google account to oss@movenext.me to express your interest in joining the closed testing group. Your participation is greatly appreciated and will help ensure a successful launch on Google Play. Thank you for your support! - -## Getting Started - -To get started with BangNavigator, simply grab the latest [release](https://github.com/FaFre/bang_navigator/releases) matching your device architecture (most probably ARM 64), which is either armeabi-v7a (ARM 32-bit), arm64-v8a (ARM 64-bit), or x86-64 (x86 64-bit). - -For now, there are only Android builds provided. - -Install the app, then obtain your Session Link (see [Kagi's Docs](https://help.kagi.com/kagi/privacy/private-browser-sessions.html#obtaining-a-session-link) for details), and paste the link into the field on the settings page. - -Settings Page - -## Quickstart guide - -Settings Page - -### Kagi Tools - -Kagi Tools - -Access Kagi's comprehensive suite of tools directly through the three-dots menu or seamlessly integrate content by sharing it from another app. This feature allows for a fluid transition between your external content and Kagi's powerful search and assistant functionalities. - -### Home Widget - -Home Widget - -The Home Widget provides quick access to key features right from your home screen. - -### Highlight - -Highlight Actions - -Easily highlight text within BangNavigator to instantly search or generate prompts. This feature simplifies the process of querying or interacting with text-based content on the web. - -### Tabs - -Tabs - -Manage multiple browsing sessions effortlessly with the tabbed browsing feature. - -### Link Actions - -Link Actions - -Interact with links through long-press or by tapping on the title to open a context-specific actions menu. This feature enhances navigation efficiency and provides quick access to a range of options like direct summarization or sharing. - -### Chat Archive - -Link Actions - -Save any conversation with the assistant on your local device with just one click. Unlike the online Kagi conversations that expire after 7 days, archived chats are saved forever on your local device. - -To archive a conversation, just press the download button and that's it! - -Link Actions \ No newline at end of file