Commit Graph
196 Commits
Author SHA1 Message Date
xixu-me b93bfa4434 Update README.md 2025-07-25 08:40:45 +08:00
xixu-me 31e25a1c6f Update multi-platform integration section in README
Simplified and unified the description of multi-platform integration features in the README. The new wording emphasizes one-stop mirroring, intelligent recognition, and a consistent acceleration experience across platforms.
2025-07-24 22:40:48 +08:00
xixu-me b264c9d713 Update documentation for clarity and formatting
Improved wording, formatting, and badge order in README.md to better highlight Xget's features and advantages. Fixed spacing and link formatting in CONTRIBUTING.md and test/README.md for consistency and readability.
2025-07-24 22:24:31 +08:00
xixu-me 38833f4c3a Update documentation to use '存储库' instead of '项目'
Replaced occurrences of '项目' (project) with '存储库' (repository) across issue templates, contributing guide, and README for consistency and clarity. Updated badges, usage examples, and contribution instructions to reflect this terminology change. No functional code changes were made.
2025-07-24 21:53:48 +08:00
xixu-me da0b518900 Update test tooling and scripts, add tsconfig.json
Modernizes test and lint scripts in package.json to use Vitest, Prettier, and ESLint directly. Updates devDependencies to latest versions. Adds a tsconfig.json for type checking and editor support. Improves test mocking in performance.test.js and updates documentation in README.md to reflect new test commands. Cleans up unused options in vitest.config.js.
2025-07-24 21:28:47 +08:00
xixu-me b34e490e6c Migrate issue templates to YAML and add contribution docs
Replaced Markdown issue templates with structured YAML templates for bug reports, feature requests, performance issues, deployment help, and platform support. Added .prettierrc.json and .prettierignore for code formatting, a detailed CONTRIBUTING.md, and a pull request template. Updated CODE_OF_CONDUCT.md and README.md to reference new contribution guidelines. Added ESLint config, test scripts, and initial test files to improve project maintainability and onboarding.
2025-07-24 21:05:13 +08:00
xixu-me cef0e26ed8 Add PyPI files proxy support and URL rewriting
Introduces a new 'pypi-files' platform configuration for proxying files from files.pythonhosted.org. Updates platform detection logic for better flexibility and rewrites PyPI simple index HTML responses to route file URLs through the proxy.
2025-07-24 19:27:28 +08:00
xixu-me 4115f931a3 Update PyPI URLs to use pypi.org domain
Changed all references from files.pythonhosted.org to pypi.org in both the README and the PyPI platform configuration. This aligns documentation and configuration with the current official PyPI domain.
2025-07-24 15:32:47 +08:00
xixu-me 0cb8351f9a Refactor and streamline README usage instructions
Updated the conda mirror table to include both default and community channels. Removed redundant direct download and batch download code examples for npm, PyPI, and conda, consolidating usage instructions. Moved and streamlined CI/CD and Docker integration examples, and clarified configuration steps for npm, pip, and conda mirrors. This makes the README more concise and focused on configuration and integration.
2025-07-24 15:12:17 +08:00
xixu-me 11076bb7ea Refactor conda channel support and update docs
Added explicit support for conda community channels in platform config and request handling. Updated README with improved conda usage instructions, new .condarc and environment.yml examples, and clarified download/configuration steps. Removed Vitest test dependencies and test files from the project.
2025-07-24 14:49:21 +08:00
xixu-me 613253c1ad Add conda platform support and update documentation
Added conda registry configuration to the platforms config and updated the README to document conda support, including usage examples, URL conversion, and configuration for conda and mamba. This enhances the service by enabling accelerated downloads and proxying for Anaconda and Miniconda packages.
2025-07-24 11:56:49 +08:00
xixu-me 5296a2c4b9 Add PyPI support to documentation and platform config
Extended the README with instructions and examples for accelerating PyPI (Python package) downloads and pip configuration. Added PyPI platform configuration to src/config/platforms.js to enable proxying of files.pythonhosted.org URLs.
2025-07-24 11:51:01 +08:00
xixu-me 535f07a993 Add npm registry support and documentation
Added npm registry as a supported platform in the codebase and updated the README with usage instructions, examples, and configuration details for npm package acceleration. This enhances the tool's capabilities to accelerate npm package downloads and metadata retrieval.
2025-07-24 11:46:47 +08:00
xixu-me 404d1051e4 Update VSCode download link and section heading in README
Changed the VSCode download URL from a .deb file to a .zip archive and updated the section heading from '环境变量' to '配置参数' for clarity.
2025-07-22 19:05:10 +08:00
xixu-me 2f55456ea3 Update Hugging Face mirror usage example in README
Expanded the Hugging Face mirror example to use AutoModelForCausalLM, added explanatory comments, and provided a sample inference snippet. This improves clarity for users on how to load models and tokenizers via the Xget mirror.
2025-07-22 18:56:52 +08:00
xixu-me 78086a8db7 Update README with improved Xget usage examples
Replaces outdated VSCode download link with the latest archive link and clarifies usage of Xget acceleration in code. Adds explicit examples for specifying the Xget mirror directly in model loading functions.
2025-07-22 14:06:04 +08:00
xixu-me 01c61490de Update example URLs in README for clarity
Replaced hardcoded repository and file names in example commands with placeholders to improve clarity and generality. This helps users understand where to substitute their own project-specific information when using the documented commands.
2025-07-22 13:30:27 +08:00
xixu-me 713c370cae Update accelerated link formats in README table
Revised the accelerated link format examples for GitHub, GitLab, and Hugging Face in the documentation table to use '...' instead of '[路径]' for consistency and clarity.
2025-07-22 12:57:35 +08:00
xixu-me bf287467e4 Update link format section in README
Replaced the plain text description of link conversion formats with a markdown table for better clarity and readability. Added specific examples for GitHub, GitLab, and Hugging Face platforms.
2025-07-22 12:54:17 +08:00
xixu-me b01bbd04ed Update dataset links in README
Replaced wikitext dataset links with SQuAD dataset links in the README to reflect the new data source.
2025-07-22 12:03:40 +08:00
xixu-me d11c6fd505 Update README examples for Hugging Face datasets
Replaced Hugging Face dataset example links from SQuAD to Wikitext-103 in both usage examples and CI instructions. Also simplified section headings for GitHub, GitLab, and Hugging Face examples.
2025-07-22 12:01:41 +08:00
xixu-me 0f681fe7d1 Expand and clarify usage instructions in README
The README now provides detailed link conversion rules, platform-specific examples, and comprehensive integration guides for Git, wget, curl, aria2, Python, CI/CD pipelines, Docker, and IDEs. These enhancements aim to help users quickly adopt Xget in various development and deployment scenarios.
2025-07-22 11:57:13 +08:00
xixu-me d35194141f Update example URLs and platform table in README
Replaces placeholder URLs with real repository and model examples for GitHub, GitLab, and Hugging Face in the usage instructions. Updates the supported platforms table to use actual project names, improving clarity and usability for users.
2025-07-22 09:32:29 +08:00
xixu-me e121fe8891 Update README with retry, cache, and troubleshooting info
Clarified retry strategy as linear delay, specified cache duration in seconds, and improved configuration comments for clarity. Added performance tuning suggestions and a new troubleshooting section covering common issues, performance metrics, and debugging tips.
2025-07-21 20:20:37 +08:00
xixu-me e52c4d6936 Update project description in README
Removed reference to Cloudflare Workers in the project description to better reflect the current scope of the proxy service.
2025-07-21 20:17:06 +08:00
xixu-me 3fc0b1d5e7 Update Chromium Extension badge link in README
Changed the Chromium Extension badge link to point to the ecosystem integration section instead of the browser extension section.
2025-07-21 20:16:22 +08:00
xixu-me 7732252cb4 Expand and reorganize feature documentation in README
The README now provides more detailed and structured descriptions of Xget's features, including global edge distribution, platform integration, enterprise security, modern architecture, Git protocol compatibility, and ecosystem integration. Redundant sections on browser extension, performance, and security were removed or merged for clarity. Example URLs and usage instructions were also updated for better guidance.
2025-07-21 20:15:49 +08:00
xixu-me 54e0b91263 Update README wording for repository references
Replaced occurrences of '仓库' with '存储库' and updated related instructions for consistency and clarity in the deployment and usage sections.
2025-07-21 19:54:32 +08:00
xixu-me 2974180f53 Update README to clarify Git operation support
Expanded documentation to emphasize support for both file downloads and Git operations (clone, push, pull) via the proxy service. Adjusted section headings and usage examples for better clarity.
2025-07-21 19:49:42 +08:00
xixu-me e400971918 Update and expand README with usage and deployment guides
The README has been significantly revised to provide clearer instructions for quick use, deployment (including one-click Cloudflare Workers deployment and manual setup), and configuration. It now includes detailed usage examples for GitHub, GitLab, and Hugging Face, as well as information on browser extension support, security features, performance benefits, and legal disclaimers. The documentation is more structured, with new sections for features, supported platforms, and development instructions.
2025-07-21 19:41:17 +08:00
xixu-me a73be14895 Update extension references to Xget for Chromium
Changed all mentions of 'Xget for Chrome' to 'Xget for Chromium' in the README, including repository and release links, to reflect the updated extension name and repository location.
2025-07-21 17:06:09 +08:00
xixu-me 7ec7cf758a Update download links in README
Revised the Chrome and Edge store links to include language and region parameters, and updated their display names for clarity.
2025-07-21 15:17:54 +08:00
xixu-me 50a5fa1417 Update README with full Git operation support
Added documentation for complete Git operation support, including clone, fetch, pull, and push commands for GitHub, GitLab, and Hugging Face repositories. Clarified that Git operations bypass caching and described intelligent Git protocol detection and handling. Updated usage examples and technical details to reflect these enhancements.
2025-07-21 14:42:51 +08:00
xixu-me 029b3ad09c Update installation instructions in README
Added GitHub Releases link and clarified compatibility for all Chromium-based browsers in the installation section.
2025-07-12 10:04:19 +08:00
xixu-me 22cb587853 Update Chrome extension link text in README
Changed the link text from 'Xget for Chrome 扩展程序' to 'Xget for Chrome 存储库' for clarity in the README.
2025-07-12 10:02:29 +08:00
xixu-me 8c74be766b Update README wording for supported platforms
Revised the description to clarify that downloads are accelerated from GitHub, GitLab, and Hugging Face, removing the reference to '热门平台'.
2025-07-12 10:01:19 +08:00
xixu-me 8acaef8808 Translate README to Simplified Chinese
The README.md file has been fully translated from English to Simplified Chinese to improve accessibility for Chinese-speaking users. All sections, feature lists, usage instructions, and technical details are now provided in Chinese.
2025-07-12 10:00:23 +08:00
xixu-me f8bddb8a97 Update Edge Add-ons link in README
Replaced the Microsoft Edge Add-ons URL with the correct extension link to ensure users are directed to the proper page.
2025-07-11 19:08:26 +08:00
xixu-me b609ad3247 Add .crx file option for Chromium browsers
Updated the README to mention installation via .crx file for Chromium-based browsers other than Chrome and Edge.
2025-07-11 18:35:21 +08:00
xixu-me 3a1f5a6491 Update README with Chrome extension instructions
Added recommended usage section for the Xget Chrome extension, including links to the Chrome Web Store and Microsoft Edge Add-ons. Clarified manual URL prefixing as an alternative method.
2025-07-11 17:12:18 +08:00
xixu-me 137b28ee3b Remove Kaggle support from documentation and config
Kaggle references have been removed from the README and the platforms configuration. This reflects the discontinuation of Kaggle proxy support in the project. Also adds a Dependabot configuration for GitHub Actions updates.
2025-07-09 14:43:41 +08:00
xixu-me 9df8d60b52 Update README.md 2025-06-02 23:11:53 +08:00
xixu-me e397b61f36 Update README.md 2025-03-23 16:14:13 +08:00
xixu-me 599710dacb Update README.md 2025-03-23 16:13:42 +08:00
xixu-me 4ae4f5a44d Update README.md 2025-01-10 17:06:23 +08:00
xixu-me 5b1e7c8725 Initial commit 2024-11-01 17:11:15 +08:00