README added mission #1972
Merged
README added mission #1972
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
… will be first contact with celo
Codecov Report
@@ Coverage Diff @@
## master #1972 +/- ##
=========================================
Coverage ? 74.45%
=========================================
Files ? 281
Lines ? 7817
Branches ? 973
=========================================
Hits ? 5820
Misses ? 1880
Partials ? 117
Continue to review full report at Codecov.
|
Closed
timmoreton
approved these changes
Dec 5, 2019
| @@ -9,6 +9,19 @@ and other packages. | |||
|
|
|||
| The source code for the Celo Blockchain which operates a node on the Celo Network is kept in a separate repo [here](https://github.com/celo-org/celo-blockchain). | |||
|
|
|||
| ### Celo's Mission - Prosperity for All | |||
aaronmgdr
added a commit
that referenced
this pull request
Dec 5, 2019
* master: (208 commits) Fix potential hard timeouts (#2072) Add checkzero,blockscout,mulit-address support to faucet. Fix broken envType checks (#2068) README added mission (#1972) Add dev-utils README (#2081) Add validator:status command to check if a validator signer is online and producing blocks (#1906) Experience Brand Kit 1.0 (#1948) Adjust reference to the rewards app (#2065) [Wallet] Compatibility with exchange rate in string format (#2060) Fix Typo in CI config (#2056) Fix additional attestations instructions (#2057) Allow a specified address to disable/enable rewards distribution (#1828) Aaronmgdr/leaderboard patch (#2055) Move attestation service instructions to main page (#2051) Point To Updated Join Celo Video (#2052) Fix minor issue withe the ordering of instructions changes to docs related to discovery (#2025) [Docs] Fix typos in Running a Validator docs (#2045) Add node flag to celocli to set the target node for a single command (#2020) Fix broken links and spruce up CLI docs for accounts command (#2027) Prevent clipping of arrow component (#2036) ... # Conflicts: # packages/web/src/layout/BookLayout.tsx # packages/web/src/lib.dom.d.ts
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.
Descriptions
Added the mission statement
Added an embed image + link to youtube video
Rationale: For some users the celo monorepo could be the first impression they have of celo. A
A nice README is a good way to help people engage in the project as well. A project with nice README and screenshots will get the attention of users better since it’s a direct way to explain why this project matters, and why people should use and contribute to the project. Good README should also include enough details to help a new user get started, e.g. how to compile, how to install, and how to start integrating.
README educational content I used.
A beginners guide to writing kickass readmes
AWESOME READMEs