Repository navigation
docs(repo): give the README a header block and a shorter guide - #6
Merged
Merged
Conversation
The README ran to 191 lines, and 60 of them were maintainer set-up. It now has a centred header, the notice, the install command with a plain note that Packagist does not serve the package yet, two examples that the tests run, a table of the main functions, and links to the live guide and reference. The set-up, contract and change-file steps move to docs/developing.md. The long client walk-through stays on the docs site. The README tests now find the client example under "Call the gateway", and the tests for the two removed examples go with them. 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 the other Gatepost repos use: a
centred logo with a dark version, a tagline, badges, a row of links
and the notice that the project is unofficial. It is shorter, because
the docs site holds the full guide and the reference. It keeps the
install command with a plain note that Packagist does not serve the
package yet, two examples that the tests run, and a table of the main
functions.
The steps for maintainers move to docs/developing.md, and the README
links them in one line.
Signed-off-by: MobileMage aidelojejoshua@gmail.com