doc: make README header engaging #2354
Merged
Conversation
This file contains 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
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.
Description
Change the beginning of the README to include the Stellar logo, and Stellar's mission.
See it rendered at:
https://github.com/leighmcculloch/stellar--stellar-core/blob/sparkle/README.md
This repository is an entry point to external contributions and interest. At GitHub Universe one of the talks I attended talked about how creating an inviting and engaging README makes a huge difference to engaging developers who discover a project. The dev.to README was given as an example. Adding our logo and including our mission is just one small thing we can to engage a newcomer.
This same change has been made on some of our other repositories: stellar/go#1948, stellar/stellar-protocol#465, stellar/js-stellar-sdk#459.
Checklist
Ranclang-formatv5.0.0 (viamake formator the Visual Studio extension)CompilesRan all testsIf change impacts performance, include supporting evidence per the performance document