Commit Graph
60 Commits
Author SHA1 Message Date
Claude f94c8b0115 Update documentation with Docker Hub container registry support
This commit updates all documentation to reflect the new Docker Hub support:

Documentation updates:
- Add Docker Hub to container registry tables in README.md and README.en.md
- Add Docker Hub examples showing both official and user images
- Update CLAUDE.md with Docker Hub platform category and special handling notes

Docker Hub usage examples:
- Official images: /cr/docker/v2/nginx/manifests/latest
- User images: /cr/docker/v2/nginxinc/nginx-unprivileged/manifests/latest

Docker Hub is now listed as the first container registry in documentation tables, reflecting its position as the most widely used container registry.
2025-11-09 07:21:31 +00:00
xixu-me d67bbc819a Emphasize link to technical analysis article in README
Updated the formatting of the technical analysis article link in the README to use bold and italics for greater emphasis.
2025-11-07 15:49:32 +08:00
xixu-me c813293c87 Update Cloudflare deployment instructions in README
Improved the deployment steps in both English and Chinese README files by adding direct links for forking the repository and updating the instructions for obtaining Cloudflare credentials and configuring GitHub secrets for clarity.
2025-11-07 15:43:36 +08:00
xixu-me 783ae8f3bd Update deployment steps formatting in README files
Streamlined the formatting of deployment steps in both English and Chinese README files by merging multi-line list items into single lines for improved readability.
2025-11-07 15:01:47 +08:00
xixu-me 1f28ee87d6 Update README docs and remove test script
Improved and clarified English documentation in README.en.md and README.md, including badge labels, section titles, and usage instructions for better accuracy and readability. Removed the obsolete scripts/test.js file.
2025-11-07 14:47:43 +08:00
xixu-me 755abc127d Add GitHub Actions deploy workflow and update docs
Introduced a new GitHub Actions workflow for automatic deployment to Cloudflare Workers. Added CLAUDE.md for Claude Code guidance. Updated deployment instructions in both English and Chinese README files to reflect the new GitHub Actions-based deployment process.
2025-11-07 13:19:24 +08:00
xixu-me e66ae893d9 Add Siray platform support
Added Siray to the list of supported AI inference providers in documentation and configuration. This enables API acceleration for Siray via the platform configuration.
2025-11-06 18:12:21 +08:00
xixu-me 034db6a9e5 Add badges and links to README.en.md 2025-10-20 13:30:53 +08:00
xixu-me 59a7fc9b34 Update README to clarify repository cloning step
Removed the Project Mission section from the English README and updated the quick start instructions in both English and Chinese READMEs to use 'Clone Repository' instead of 'Clone Project' for clarity.
2025-10-07 22:16:42 +08:00
xixu-me 33f608a420 Emphasize technical article links in README files
Updated the formatting of the technical in-depth analysis article links in both English and Chinese README files to use bold or bold-italic markdown for greater emphasis.
2025-10-07 22:13:06 +08:00
xixu-me 65ed430430 Update project description in README files
Refined the project description in both English and Chinese README files for improved clarity and readability.
2025-10-07 22:09:23 +08:00
xixu-me 88ab58a98f Update README instructions and add technical article link
Revised the English README to improve the project description and added a link to a technical deep-dive article. Simplified Jenkins update site instructions in both English and Chinese READMEs for clarity.
2025-10-07 21:49:28 +08:00
xixu-me 6faa51d3aa Add DeepWiki badge to README files
Introduced a DeepWiki badge with link to both English and Chinese README files to highlight integration with DeepWiki.
2025-10-01 15:38:00 +08:00
xixu-me 91775d33a4 Add English README and update main README
Added a comprehensive English documentation file (README.en.md) for Xget, detailing features, usage, and platform integration. Updated the main README.md to reference the new English version.
2025-09-30 15:48:55 +08:00
xixu-me 9b461bf271 Remove English README and translation workflow
Deleted the auto-translation GitHub Actions workflow and the generated README.en.md file. Updated README.md, likely to remove references to the English version and translation automation.
2025-08-31 21:52:46 +08:00
xixu-me 17b9915f60 Update README legal compliance and badge links
Improved wording on legal compliance and user responsibility in both English and Chinese README files. Updated Cloudflare Workers badge links to point to the correct section anchors.
2025-08-31 17:41:50 +08:00
xixu-me 3dcbe599e9 Update documentation with vision and deployment details
Added a new 'Repository Vision' section to the English README, clarifying the project's goals and benefits. Expanded deployment instructions with more details and recommendations, especially for Cloudflare Workers. Minor wording improvements and consistency updates in the Chinese README and SECURITY.md.
2025-08-31 17:24:39 +08:00
xixu-me 382824fe2e Update deployment and platform notes in README files
Emphasized Cloudflare Workers as highly recommended, adjusted Docker image recommendation wording, and clarified third-party platform respect statements in both English and Chinese README files. Updated references to container registries and removed Docker Hub from the list for consistency.
2025-08-31 16:55:21 +08:00
xixu-me 017d331d6e Update language label in README
Changed the language label from '中文' to '汉语' in the English README for clarity.
2025-08-31 15:45:05 +08:00
xixu-me c54a54b43b Update and expand disclaimer in README files
Revised the disclaimer sections in both English and Chinese README files to provide more comprehensive information on legal compliance, service availability, data privacy, liability, third-party platform respect, intellectual property, and security risks. The updates clarify usage boundaries and user responsibilities.
2025-08-30 13:23:19 +08:00
xixu-me fc2c02f6ae Fix Civitai badge URL and minor formatting in README files
Removed unused logo parameters from the Civitai badge in both English and Chinese README files. Also fixed minor whitespace formatting in code examples in the Chinese README.
2025-08-20 21:52:38 +08:00
xixu-me 44e31aa5bd Add Civitai support and usage examples to README
Added Civitai badge, URL transformation instructions, and Python usage examples for the Civitai AI model platform to both English and Chinese README files. This update documents how to accelerate Civitai model downloads and API access via the Xget service.
2025-08-20 21:43:27 +08:00
xixu-me 44d550ce16 Update deployment badge links in README files
Changed the badge links for Cloudflare Workers, Vercel, and Docker in both English and Chinese README files to point to their respective sections directly, improving navigation.
2025-08-19 21:51:49 +08:00
xixu-me 83d2dfb322 Simplify deployment section in README files
Streamlined the deployment instructions in both English and Chinese README files by removing the manual deployment section and consolidating the headings for Cloudflare Workers, Vercel, and Docker. This makes the deployment options clearer and reduces redundancy.
2025-08-19 21:50:22 +08:00
xixu-me fdff94fa4d Add Docker deployment instructions to README
Added a new section to the README with detailed instructions for deploying using Docker, Docker Compose, and Kubernetes. Also updated badges to include Docker and made minor formatting improvements throughout the file.
2025-08-19 21:38:38 +08:00
xixu-me 0e767e9200 Remove VERCEL_DEPLOYMENT.md reference from README
Updated both English and Chinese README files to remove the reference to VERCEL_DEPLOYMENT.md in the Vercel deployment section.
2025-08-17 17:56:13 +08:00
xixu-me 34c0827113 Add Vercel Edge Function support for Xget
Introduces Vercel deployment support by adding Edge Function handlers in the api directory, Vercel configuration files, and related ignore rules. Updates documentation to include Vercel one-click deployment instructions and badges. Adds Vercel-specific scripts to package.json for development and deployment workflows.
2025-08-17 17:41:34 +08:00
xixu-me 03df08998f Update README with URL converter info
Added information about the new URL converter (xuc.xi-xu.me) to both English and Chinese README files. Also adjusted formatting for public instance mentions for consistency.
2025-08-17 17:30:17 +08:00
xixu-me 9e802ed10d Update Wrangler login command in README files
Replaces 'npx wrangler auth login' with 'npx wrangler login' in both English and Chinese README files to reflect the updated Wrangler CLI authentication command.
2025-08-17 11:50:16 +08:00
xixu-me 60dfef4e98 Update Xget OpenAI API base_url in README files
Changed the example base_url for Xget-accelerated OpenAI API from '/ip/openai' to '/ip/openai/v1' in both English and Chinese README files to reflect the correct endpoint.
2025-08-14 19:09:20 +08:00
xixu-me fe6640e76a Revise and enhance English README for clarity and accuracy
Improved language, consistency, and technical accuracy throughout the README.en.md file. Updated terminology (e.g., 'link' to 'URL', 'conversion' to 'transformation'), clarified instructions, corrected section titles, and enhanced example explanations. Streamlined descriptions for platform support, usage scenarios, and configuration steps to provide a clearer and more professional guide for users.
2025-08-14 18:32:29 +08:00
xixu-me 1bf4a51ffa Add AI inference provider acceleration to README
Expanded the README to document support for AI inference API acceleration, including a new badge, provider table, usage examples, environment variable configuration, and performance comparisons. This update details how to use Xget to accelerate API calls to over 25 mainstream AI inference providers, with code samples and production deployment recommendations.
2025-08-14 17:30:00 +08:00
xixu-me 7016ead887 Update README wording for acceleration experience
Replaces 'download experience' with 'acceleration experience' in both English and Chinese README files for clarity and consistency.
2025-08-14 16:27:41 +08:00
xixu-me 2ae8ce15be Add Homebrew mirror support and usage instructions
Updated README.en.md to include Homebrew badge, mirror table entries, usage examples, and detailed configuration instructions for accelerating Homebrew with Xget. Removed Homebrew performance comparison section from README.md.
2025-08-11 09:46:03 +08:00
xixu-me 6e183040ec Update README.en.md 2025-08-10 23:00:19 +08:00
xixu-me bd36cb75e3 Fix CTAN badge anchor links in README files
Updated the CTAN badge anchor links in both English and Chinese README files to use the correct section IDs, ensuring proper navigation.
2025-08-08 19:04:39 +08:00
xixu-me 689ea2ebee Add Apache software download acceleration support
Added Apache as a supported platform in the documentation and configuration. Updated both English and Chinese README files with instructions and examples for accelerating Apache software downloads via Xget, and registered the Apache platform in the platforms.js config.
2025-08-08 18:52:00 +08:00
xixu-me 6f0914e001 Add AOSP, CPAN, and CTAN platform support
Added support and documentation for AOSP (Android Open Source Project), CPAN (Perl), and CTAN (TeX/LaTeX) mirrors in both English and Chinese README files. Updated src/config/platforms.js to include these platforms. No functional changes to request handling logic.
2025-08-08 18:44:39 +08:00
xixu-me ae67123de3 Remove PyTorch platform support and related tests
This commit removes all code, documentation, and tests related to the PyTorch platform. PyTorch is no longer listed as a supported platform in the configuration, README files, or test suites.
2025-08-07 14:53:47 +08:00
xixu-me 7336649595 Add PyTorch platform support and URL rewriting
Introduces PyTorch platform support with URL rewriting for wheel index pages in src/index.js. Updates documentation in both English and Chinese READMEs to reflect new PyTorch installation URLs and verification steps. Adds comprehensive tests for PyTorch proxying, URL transformation, and error handling in test/index.test.js and new test/pytorch.test.js.
2025-08-07 14:07:09 +08:00
xixu-me b4af10603a Add PyTorch platform support and documentation
Introduces PyTorch as a supported platform in the configuration, updates test utilities and test cases for PyTorch URLs, and adds detailed usage and acceleration instructions for PyTorch in both English and Chinese README files.
2025-08-07 13:51:28 +08:00
xixu-me ae3f41b4f4 Clarify container registry names in documentation
Updated both English and Chinese README files to use more precise and consistent names for various container registries in the supported registries table and related documentation sections. This improves clarity for users by specifying full registry names and aligning terminology across both language versions.
2025-08-07 13:38:22 +08:00
xixu-me 781357fa6d Update CRAN ggplot2 version in docs and tests
Changed references of ggplot2 from version 3.4.4 to 3.5.2 in both English and Chinese README files and updated related test cases in cran.test.js to ensure consistency with the latest package version.
2025-07-31 18:14:55 +08:00
xixu-me 0dc07a01f3 Update Gitea archive path from main.zip to master.zip
Changed documentation and test cases to use 'master.zip' instead of 'main.zip' for Gitea archive URLs to reflect the correct branch naming.
2025-07-31 18:01:30 +08:00
xixu-me 647caa6823 Update Gradle plugin example URLs in README files
Replaced outdated Gradle plugin and metadata example URLs with new plugin examples in both English and Chinese README files to provide more relevant and up-to-date references.
2025-07-31 17:47:22 +08:00
xixu-me 9d8c924adb Expand README with CRAN, Rust, openSUSE, and F-Droid support
Added badges, conversion examples, and configuration instructions for CRAN (R), Rust Crates, openSUSE, and F-Droid mirrors. Improved and clarified documentation for multi-platform integration, updated section titles, and enhanced usage examples for new platforms. Various language and formatting improvements for clarity and consistency.
2025-07-31 17:28:45 +08:00
xixu-me da98197fdb Update README description for resource coverage
Added 'etc.' to the list of supported resource types in the project description to clarify broader coverage.
2025-07-29 13:42:11 +08:00
xixu-me 641e3756a6 Move academic resource acceleration section up
Relocated the academic resource acceleration (arXiv download) section above the container image acceleration section in both English and Chinese README files for improved documentation structure and visibility.
2025-07-29 10:07:15 +08:00
xixu-me 47e5882346 Expand README with more platforms and usage examples
Added support and documentation for additional platforms including Gitea, Codeberg, SourceForge, Maven, Gradle, RubyGems, Go, NuGet, Packagist, and various Linux distributions. Expanded usage examples and configuration instructions for these platforms, improved clarity and consistency in language, and updated sections on Git global acceleration, academic resource acceleration, and package manager integration. Minor language and formatting improvements throughout. Also updated a test README for clearer language.
2025-07-28 21:45:19 +08:00
xixu-me 2680618594 Improve star history chart with dark mode support
Replaced the static star history chart image with a <picture> element that supports both dark and light themes in README.en.md and README.md. This enhances the visual experience for users with different color scheme preferences.
2025-07-28 15:39:46 +08:00