Repository navigation
docs: give the README a header block and a real vector - #12
Merged
Merged
Conversation
The old README gave a reader no sign of what the spec defines, who uses it or how to change it. The new one shows the three forms of a postcode and one real vector, lists the SDK repos, links the live docs site and sends questions to Discussions. A test compares the shown vector with vectors/contains.json, so the example cannot drift. Signed-off-by: MobileMage <aidelojejoshua@gmail.com>
The template now has the centred header block, the notice as a quote, a link row, a second example and a function table. DOC-2 sets the length limits, sends questions to Discussions and asks for a plain note on an unpublished package. The standards version goes from 1.1 to 1.2. Signed-off-by: MobileMage <aidelojejoshua@gmail.com>
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.
The README now has the look that most well-known projects share: a
centred logo with a dark version, a tagline, badges for CI and the
licence, a row of links, and the notice that the project is
unofficial. It shows a postcode in its three forms and one real test
vector, and a test checks that vector against the vectors file.
The README template and the standard change with it, so every repo
follows the same look. The standard also asks for a plain note beside
an install command when the package is not on its registry yet.
Signed-off-by: MobileMage aidelojejoshua@gmail.com