Skip to content

Rewrite the README around the free API, the hosted API and the roadmap - #10

Open
davd-gzl wants to merge 1 commit into
mainfrom
readme-redo
Open

davd-gzl wants to merge 1 commit into
mainfrom
readme-redo

Conversation

@davd-gzl

@davd-gzl davd-gzl commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

Before: the README opened with a "work in progress" warning and a long operator table, and didn't say where the project is going.

After: a usual project README. It has badges, a short pitch, a quick start with curl requests, an operators table with countries, a free vs hosted API comparison, a "how it works" diagram, a roadmap linking MAX-Finder issues #84 to #94, plus develop, contributing and licence sections.

How: README.md only.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant