From d0c1699acf0c4bcf10c26f2166a84bff9ebeeae0 Mon Sep 17 00:00:00 2001 From: h-akatsuki <163324658+h-akatsuki@users.noreply.github.com> Date: Sun, 25 Aug 2024 14:16:48 +0900 Subject: [PATCH] Update README.md --- README.md | 126 ++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 85 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index b42b3bf..08e30b3 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,105 @@ # Hitomi Search Plus -Hitomi Search Plus is a Flutter application for browsing and searching the Hitomi.la gallery. This project aims to provide a user-friendly interface for exploring content with advanced features like bookmarking, search history, and custom tag suggestions. +

+ Hitomi Search Plus Logo +

-## Steps(Temp) -- [x] Write code -- [x] Set up github actions(build) - - [x] Android - - [ ] Windows ???? -- [ ] Compile README.md +

+ A fast and efficient Hitomi.la search application +

-## Features +

+ + Latest Release + + + Join Discord + +

-- Responsive design for both mobile and desktop platforms -- Material 3 design implementation -- Advanced search functionality with custom tag suggestions -- Bookmarking system for easy access to favorite content -- Search history for quick reference to past queries -- Online reader for viewing gallery content +## Overview and Installation -## Getting Started +Hitomi Search Plus is a lightweight and fast Flutter application that provides advanced search capabilities for Hitomi.la. Using efficient algorithms and optimized data structures, it can search through massive amounts of data and display results instantly. -### Prerequisites +### Key Features -- Flutter SDK (latest stable version) -- Dart SDK -- An IDE (e.g., Android Studio, VS Code) +- Blazing fast search performance +- Advanced search operations including grouping, OR, and AND +- High-speed suggestion functionality powered by Rust +- Per-query bookmarking with automatic updates +- Modern UI design with Material Design +- Standard features including gallery view and favorites ### Installation -1. Clone the repository: - ``` - git clone https://github.com/your-username/hitomi-search-plus.git - ``` +Hitomi Search Plus supports the following platforms: -2. Navigate to the project directory: - ``` - cd hitomi-search-plus - ``` +- Android (Fully Supported) +- Windows (Partially Supported - Some layout optimizations missing) -3. Get the dependencies: - ``` - flutter pub get - ``` +For other platforms, please refer to the official Flutter documentation. -4. Run the app: - ``` - flutter run - ``` +Download the latest version from the [Releases Page](https://github.com/your_username/hitomi_search_plus/releases). -## Contributing -Contributions are welcome! Please feel free to submit a Pull Request. +## Key Features and Demo + +### Lightweight + +- No data download required on startup +- Custom-designed powerful downloader prioritizes images (6 parallel downloads) +- All operations are asynchronous, preventing application freezes +- Fast suggestion powered by a small 2MB index file and Rust + +### Advanced Search Functionality + +Hitomi Search Plus offers powerful search capabilities, allowing you to easily construct complex search queries. + +- Flexible query creation with OR and AND operators +- Grouping for building complex search conditions + - Example: `((tag:name | tag:name2) -tag:name3) | tag:name4` +- Fast suggestion (see real-time performance in the demo video) +- Add custom tags (e.g., `language:none`) +- Infinite scrolling search results + - Jump to specific index +- Customized string search for exact matches + - Search speed equivalent to tag search + +| Mobile UI Demo | Desktop Screenshot | +|---|---| +| | Desktop Search Screen | -## License -This project is licensed under the [MIT License](LICENSE). +### Smart Bookmarks -## Disclaimer +- Bookmark queries directly, not just tags + - Apply default queries individually + - Manage bookmarks with custom titles +- Automatic background updates + - Processed in bulk via a custom-built search server + - Typically processes complex queries (including those with over 50 tags) within 500ms +- Automatic sorting by update order + +| Bookmark List | Bookmark Editing | +|---|---| +| Bookmark Overview Screen | Desktop Bookmark Editing Screen | + + +### Viewer + +- Scroll Mode + - Jump to specific index + - Automatic image resizing +- Page Mode + - Fullscreen functionality + - Three display options: + - Single Page + - Double Page + - Double Page (with Cover) +- Smart caching that prioritizes surrounding pages +- Zoom with `Ctrl + Wheel` + + +## License -This application is intended for educational purposes only. Users are responsible for complying with all applicable laws and regulations regarding the content they access. \ No newline at end of file +Hitomi Search Plus is released under the Apache License 2.0.