Commit Graph
89 Commits
Author SHA1 Message Date
xixu-me 61c0181c26 Add Gitee 2025 award voting notice to README
Added a prominent message in both English and Chinese README files to encourage users to vote for Xget in the Gitee 2025 Open Source Software Awards.
2025-12-08 16:07:29 +08:00
xixu-me 207401fd89 Reorder and update badges in README files
Moved 'Ask Zread', 'Ask DeepWiki', 'Chromium', and 'Firefox' badges to the top of the badge section in both README.en.md and README.md. This improves badge visibility and maintains consistency across documentation.
2025-11-27 18:11:46 +08:00
xixu-me 9cdd05410b Add Deno Deploy badge and deployment instructions
Added a Deno Deploy badge to the README files and provided step-by-step instructions for deploying the project to Deno Deploy, including switching the default branch and connecting the repository. This update improves documentation for users who want to deploy using Deno Deploy.
2025-11-27 18:07:35 +08:00
xixu-me 076b64ff9e Update deployment instructions for Vercel and EdgeOne
Clarified and expanded the required GitHub secrets for Vercel deployments, including Team ID and Project ID, and updated token naming for EdgeOne in both English and Chinese README files. Improved wording for Netlify Project ID instructions.
2025-11-25 18:52:26 +08:00
xixu-me 7c49d905a1 Add Netlify deployment instructions to README
Added Netlify deployment badge and detailed deployment steps to both English and Chinese README files. Also clarified that Workers code is converted to Functions-compatible format for both Vercel and Netlify workflows.
2025-11-25 18:19:58 +08:00
xixu-me 870014ba03 Add Vercel deployment instructions and badge
Added Vercel deployment badge and detailed deployment steps to both English and Chinese README files. Updated the GitHub Actions workflow commit messages to generalize function conversion steps and removed detailed change lists. Minor wording improvements in the Chinese README for consistency.
2025-11-25 16:15:18 +08:00
xixu-me 7f01ebe059 Add DigitalOcean deployment guide and update README
Removed the sponsors section from both English and Chinese README files and added a new section referencing a detailed deployment guide for running Xget on DigitalOcean. Introduced docs/deploy-on-digitalocean.md with comprehensive instructions for deploying and optimizing Xget using Droplets, App Platform, and Kubernetes on DigitalOcean.
2025-11-24 14:24:40 +08:00
xixu-me 1f3fc06c2b Update sponsor section and links in docs and config
Added a new sponsors section with DigitalOcean and DartNode badges to both English and Chinese README files. Updated image tags to remove inline styles for badges. Modified the issue template config to update the public instance link and description.
2025-11-21 21:01:23 +08:00
xixu-me 89551136d7 Update API usage examples and rename Anthropic to Claude
Revised Python and JavaScript code samples in both English and Chinese READMEs to use updated OpenAI, Claude (formerly Anthropic), and Gemini API interfaces. Renamed references from 'Anthropic' to 'Claude' throughout documentation and config comments for clarity. Also updated tsconfig.json formatting for consistency.
2025-11-20 19:32:13 +08:00
xixu-me c9de054b4d Remove Docker configuration instructions from README
Deleted the section detailing Docker registry mirror configuration for image acceleration from both English and Chinese README files. This streamlines the documentation and focuses on direct image pulling instructions.
2025-11-19 20:59:41 +08:00
xixu-me e0a861b85b Change Hugging Face logo color to black 2025-11-19 11:20:17 +08:00
xixu-me f26a122f22 Update badge links and images in README 2025-11-19 00:27:32 +08:00
xixu-me ed675ea5e8 Update README with EdgeOne Pages and clarify deployments
Added EdgeOne Pages deployment instructions and badge. Expanded and clarified deployment steps for Cloudflare Workers and Cloudflare Pages, including notes on branch automation and secret configuration. Improved self-hosted deployment notes for clarity and consistency.
2025-11-18 22:33:15 +08:00
xixu-me 7d757f99a6 Add Product Hunt badge to README
Included a Product Hunt badge in the README to highlight the project's presence on Product Hunt and improve visibility.
2025-11-18 17:50:46 +08:00
xixu-me b1239ed2a7 Update deployment URL to use server IP 2025-11-17 00:11:34 +08:00
xixu-me 3b1ee1cd2e Revert "Convert Cloudflare Worker to Cloudflare Pages" 2025-11-16 23:29:53 +08:00
Claude eabf0782d4 Convert Cloudflare Worker to Cloudflare Pages
This commit converts the entire Xget application from a Cloudflare Worker
to a Cloudflare Page, enabling static asset hosting while maintaining all
existing functionality.

Changes:
- Add functions/[[path]].js: Catch-all Pages Function handler
- Add public/index.html: Landing page with Xget information
- Update src/index.js: Export handleRequest for Pages Function import
- Update wrangler.toml: Configure for Pages deployment
- Update package.json: Change scripts to use Pages commands
- Update vitest.config.js: Include functions/ in coverage
- Update .github/workflows/depoly.yml: Deploy to Pages
- Update documentation: CLAUDE.md, README.md, README.en.md

The conversion maintains full backward compatibility with existing tests
and functionality. All caching strategies, security headers, and protocol
handling remain unchanged.
2025-11-16 15:18:34 +00:00
xixu-me 973daacf2c Update multi-platform support description in README
Revised the README files to clarify that multi-platform support covers mainstream platforms in various development scenarios, improving the accuracy of the feature description.
2025-11-16 21:03:37 +08:00
xixu-me cadf5b1275 Add Podman support and update badges in docs
Added Podman deployment instructions and badges to both English and Chinese README files. Updated several badge colors for consistency. Introduced new scripts for badge color fixes. Updated dependencies in package.json and package-lock.json. Added scripts/README.md and scripts/fix-badge-colors.js for badge management.
2025-11-16 19:31:19 +08:00
xixu-me 73108629fc Update Docker workflow and badges in README files
Added Docker badge and updated Cloudflare Workers badge links in both English and Chinese README files. In the GitHub Actions workflow, assigned an id to the Docker build-and-push step and updated the provenance attestation to use the correct digest output.
2025-11-16 18:09:48 +08:00
xixu-me ad2bf1933c Update docs, Dockerfile, and CI for container registry support
Expanded documentation in both English and Chinese READMEs to include detailed container registry acceleration usage and deployment instructions. Refactored Dockerfile to use a multi-stage build with workerd for self-hosted deployment. Improved .dockerignore for cleaner builds. Updated GitHub Actions workflows to refine path ignores and metadata extraction. Added config.capnp for workerd configuration. Removed obsolete .html file and enhanced CLAUDE.md with comprehensive architecture and development guidance.
2025-11-16 17:46:48 +08:00
xixu-me 6e5eb6878d Update disclaimers and contribution/contact info in docs
Revised the disclaimer sections in both README files for clarity, legal accuracy, and broader coverage of use cases. Updated CONTRIBUTING.md to improve language consistency and removed references to GitHub Discussions. Removed author contact and sponsorship sections from the README files.
2025-11-15 17:32:02 +08:00
xixu-me f187e22934 Fix misplaced closing div in README files
Moved the closing </div> tag to the correct position in both README.en.md and README.md to ensure proper HTML structure in the badges section.
2025-11-15 12:52:09 +08:00
xixu-me 5168db3f8c Reorder badges and Trendshift banner in README files
Moved the Trendshift banner above the badges and adjusted the README headers for better visual hierarchy in both English and Chinese README files.
2025-11-15 12:51:12 +08:00
xixu-me 65119b4bdc Add rocket emoji to project title in README files
Updated both English and Chinese README files to include a rocket emoji in the project title for improved visual appeal.
2025-11-14 17:14:24 +08:00
xixu-me 12e77c4f3f Remove redundant quick start usage line from README
Deleted a duplicate or unnecessary line in both English and Chinese README files under the Quick Start section to streamline instructions and avoid repetition.
2025-11-14 17:04:25 +08:00
xixu-me 6c903f021a Update badge anchor links in README.en.md
Changed badge anchor links from Chinese to English section headers for better consistency and accessibility in the English README.
2025-11-14 17:02:44 +08:00
xixu-me e2e79946ed Update badges and layout in README files
Reorganized and updated badges in both English and Chinese README files for improved clarity and consistency. Added new badges for Cloudflare Workers, Chromium, and Firefox, and adjusted the layout for better visual alignment.
2025-11-14 17:00:47 +08:00
xixu-me 6245da9e6f Add support for GitHub Gist platform
Added GitHub Gist ('gist') to the supported platforms in the configuration, updated documentation in both English and Chinese READMEs, and included related tests to ensure correct path transformation and base URL.
2025-11-10 20:45:58 +08:00
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