[Feature] Clarify repo audience and redirect CC tool consumers to main site #466
Labels
📖 aspect: docs
Concerns the documentation in the repository
✨ goal: improvement
Improvement to an existing feature
🟩 priority: low
Low priority and doesn't need to be rushed
🏁 status: ready for work
Ready for work
Problem
It is very unclear from the README who this codebase is for, and common public search queries may lead unsuspecting end users here while looking for licenses/tools from the main site, at which point they may decide CC is a technical utility that they cannot hope to understand. Further, even for those who think this is the repo they need to be working on, some clarity would be nice.
Description
Adda prominent note to the top of the README that declares anyone looking for CC licenses and public domain tools should go to https://creativecommons.org/share-your-work/
Add some context about who is expected to make use of this codebase in what ways, before they're submerged in all the technical stuff that follows.
Add a link to https://creativecommons.org/licenses/ (already linked in sidebar but it should be clarified that this codebase essentialy generates that page specifically).
Alternatives
I thought of converting the README to AsciiDoc so we can put a proper admonition block to get better attention, but that seems like overkill. ;-)
Implementation
The text was updated successfully, but these errors were encountered: