Suggested README improvements to clarify scope and help new contributors

[thomgit9]

Hi , I’ve found your repository very useful — thank you for making it open source.

While reading through the README, I took some time to improve the structure/clarity (mainly clarity, structure, content):

• Replace mixed HTML table with a focused badges block for the develop branch.
• Add a clear description of the library’s purpose and scope, aligning with this “non-Boost edition.”
• Provide direct links to documentation, releases, single-header artifacts, and CDash dashboard.
• Summarize the main public types and concepts (result, outcome, policies, success/failure).
• Document repository architecture (include/, single-header/, test/, doc/, cmake/, conan/, abi-compliance/, benchmark/).
• Explain installation and usage without code snippets (single-header and CMake/Conan paths).

I didn’t want to push directly on your repo without asking — so I created a fork to showcase what I mean. You can review it here: https://github.com/thomgit9/outcome/blob/develop/Readme.md

If you think some of these changes make sense, I’d be happy to open a PR.

Let me know if you’d like me to propose this as a PR directly.

Thanks again for the project — it’s been very helpful.

Best,

[ned14]

Thanks for the suggested Readme improvements. TBH it was mainly intended as a jump off point to the main docs rather than documenting anything itself. But I suppose nobody wants to click for a second time.

Your list of main classes and functions is all wrong, but that's a nitpick. Otherwise it does seem an improvement.

@BurningEnlightenment What do you think?