diff --git a/README.md b/README.md index 15c2173bd..31d6f766e 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,19 @@ # Crypto Ecosystems [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT) -[![All Contributors](https://img.shields.io/badge/all_contributors-16-orange.svg?style=flat-square)](#contributors-) -🌲 Crypto Ecosystems is a taxonomy for sharing data around open source cryptocurrency, blockchain, and decentralized ecosystems and tying them to GitHub organizations and code repositories. All of the ecosystems are specified in [TOML](https://github.com/toml-lang/toml) configuration files. +🌲 Crypto Ecosystems is a taxonomy for sharing data around open source blockchain, Web3, cryptocurrency, and decentralized ecosystems and tying them to GitHub organizations and code repositories. All of the ecosystems are specified in [TOML](https://github.com/toml-lang/toml) configuration files. This repository is not complete, and hopefully it never is as there are new ecosystems and repositories created everyday. [Browse Ecosystems Here](https://electric-capital.github.io) +## How to Contribute +There's a couple of ways you can help grow this initiative. +### Option 1: Opening a Pull Request +You can make any .toml file for an ecosystem under the `/data/ecosystems` directory or edit an existing one to help improve data around an ecosystem. + +You can fork this repository and open a PR from the forked repo to this repo. If you are not sure how to do that, you can follow the tutorial [in this video](https://www.loom.com/share/f23aab8c675940a9998b228ea1e179b7). + #### Data Format An example configuration file for the Bitcoin ecosystem looks like this: @@ -26,7 +32,7 @@ github_organizations = ["https://github.com/bitcoin", "https://github.com/bitcoi /btcsuite", "https://github.com/libbitcoin", "https://github.com/rust-bitcoin"] # Repositories -# These are structs including a url and tags for a git repository. These URLS do not have to be on GitHub. +# These are structs including a url and tags for a git repository. These URLs do not necessarily have to be on GitHub. [[repo]] url = "https://github.com/bitcoin/bitcoin" tags = [ "Protocol"] @@ -43,6 +49,9 @@ tags = [ "Wallet"] By specifying the data as evolving config files in git, we benefit from a long term, auditable database that is both human and machine readable. -#### How to Contribute -✍️ You can make any .toml file for an ecosystem in the /data/ecosystems directory or edit an existing one to help improve data around an ecosystem. Pull Requests are encouraged. +### Option 2: Complete the Ecosystem Submission form + +If you are not a developer or you find making a commit too difficult, you can use this Airtable based alternative below. + +You can [visit the form here](https://airtable.com/shrN4vZMlBLm3Dap8), fill it, submit it and we'll take care of the rest :)