sterlingwes/decap-proxy

Suggestion for improving new user experience in README

Opened this issue · 0 comments

Hi there,

First, I want to thank you for creating and sharing this fantastic repository! It's been incredibly helpful, and everything works smoothly.

I noticed a potential opportunity to further improve the README for new users, especially those unfamiliar with yarn.

Here are some suggestions:

  • Utilize npx instead of yarn: This would eliminate the need for newcomers to install yarn globally. Could we consider changing commands like:

    • yarn global add wrangler && wrangler login to npx wrangler login
    • yarn deploy to npx wrangler deploy
  • Streamline Custom Domain Configuration: The current configuration in wrangler.toml uses { pattern = "my.domain.com", zone_name = "my.domain" }. To ensure consistency with the Decap configuration mentioned later in the README, it might be beneficial to modify it to { pattern = "decap.mydomain.com", zone_name = "mydomain.com", custom_domain = true }

    This update aligns the pattern and zone name with the Decap config and leverages the custom_domain option, eliminating the need for separate configuration in the Cloudflare admin panel.

These are just some suggestions, and I'm happy to help implement them if you'd like. Thank you again for this valuable project!