docs: integrate fastFOREX as the project sponsor and recommended service - #178
Merged
Conversation
README
- Add a sponsor banner (logo, one-line pitch with concrete facts, free-API-key CTA) under the badges, with target="_blank" rel="noopener" on every link.
- Reorder for a dev-first flow: sponsor → What is Exchanger → Installation → Quickstart → Chain → Providers → positioning sections (When/Use cases/Which package) → Documentation.
- Drop "When should you use Exchanger?" / "Why Exchanger over Swap?" duplicates from the top; the same content lives further down (When + Which package) without repetition.
- Drop the bottom Sponsorship section (the top banner carries the placement on its own).
- Drop the inline Caching/HTTP/errors section; replaced by a pointer to doc/readme.md, which already covers all three in detail.
- Drop the "Related packages" section (duplicates "Which package should I use?").
- Quickstart leads with FastForex as the primary service, with the European Central Bank kept as a no-key alternative in a <details> block.
- Providers table: split into Commercial (with fastforex pinned at the top, marked with a star and in bold) and Public. Cryptonator, exchangerate.host and WebserviceX moved from Public to Commercial to reflect their upstream status; tables otherwise alphabetical and complete — no provider removed.
- Link each ecosystem package name in "Which package should I use?" to its GitHub repository.
doc/readme.md
- Add the same sponsor banner at the top, plus a one-line pointer back to the README for the project overview and ecosystem.
- Drop the three positioning sections that duplicated the README ("What is Exchanger?", "When should you use Exchanger?", "Why Exchanger over Swap?"); the doc is now a pure technical reference.
- Building Exchanger now uses FastForex as the primary example; ECB shown right after as the no-key alternative.
- Chaining services example pairs FastForex with ECB.
- Provider configuration: split into Commercial (table with FastForex pinned and in bold at the top) and Public (identifier, service class, base, quote, historical), in that order. An "Example" subsection follows with a chain and the `array` service snippet.
- Cross-links: every reference to the README's Providers table now points to the doc's local tables instead.
- Add a transparency note that Cryptonator, ExchangerateHost and WebserviceX are commercial upstream services but the current wrapper does not yet require an option for them.
- Index updated to reflect the new structure.
- Remove em-dashes from prose for consistency.
- PSR-16 cache and HTTP-cache examples now use FastForex (matches the rest of the doc; no promotional comments in code).
Sponsor copy
- Tagline: 'Real-time JSON API, 160+ currencies, 55+ years of history, 500+ cryptocurrencies. Free tier; paid plans from \$18/month.'
- All fastFOREX links use https://www.fastforex.io (avoids a 301 redirect and improves referrer attribution).
No PHP code, composer.json, tests, or service list changes. All existing services remain supported. The sponsorship is visible above the fold but the package keeps a clean open-source maintainer tone.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.