Update Readme

2023-05-20 11:23:15 +08:00 · 2023-05-20 11:23:15 +08:00 · 0c33923dec
commit 0c33923dec
parent 437359deff
1 changed files with 47 additions and 28 deletions
--- a/README.md
+++ b/README.md
@ -1,46 +1,65 @@
-# framework
+<div align="center">

-This template should help get you started developing with Vue 3 in Vite.
+![Ping Wallet](./public/logo.svg)

-## Recommended IDE Setup
+<h1>Ping Dashboard</h1>

-[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
+**Ping Dashboard is not only an explorer but also a wallet and more ... 🛠**

-## Type Support for `.vue` Imports in TS
+[![version](https://img.shields.io/github/tag/ping-pub/explorer.svg)](https://github.com/ping-pub/explorer/releases/latest)
+[![GitHub](https://img.shields.io/github/license/ping-pub/explorer.svg)](https://github.com/ping-pub/explorer/blob/master/LICENSE)
+[![Ping Deploy](https://github.com/ping-pub/explorer/actions/workflows/mainnet-deploy.yaml/badge.svg)](https://github.com/ping-pub/explorer/actions/workflows/mainnet-deploy.yaml)
+[![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/bukotsunikki.svg?style=social&label=Follow%20%40ping_pub)](https://twitter.com/ping_pub)
+[![https://discord.gg/CmjYVSr6GW](https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord&longCache=true&style=flat)](https://discord.gg/CmjYVSr6GW)

-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.

-If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
+</div>

-1. Disable the built-in TypeScript Extension
-    1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
-    2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
-2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
+`Ping Dashboard` is a light explorer for Cosmos-based Blockchains.  https://ping.pub .

-## Customize configuration
+## What is the difference between Ping explorer and other explorers? 

-See [Vite Configuration Reference](https://vitejs.dev/config/).
+`Ping Dashboard` is designed to explore blockchain data as real as possible, therefore there is no cache, no pre-processing. `Ping Dashboard` only fetch data from Cosmos full node via LCD/RPC endpoints. We call it "Light Explorer".

-## Project Setup
+## Do you want to list your blockchain on ping.pub?

-```sh
-npm install
+Submit your pull request [here](./src/chains), We will add your chains as soon as possible. It is **FREE** (You must have 10+ independent validators on your chain).
+
+We remain neutral to all chains, and we do not comment on their market prospects, technical risks, or investment risks. The only condition we list on ping.pub is if there are ten validators, and we cannot determine if these validators are controlled by the same entity.
+
+## Why Ping explorer use official/trusted third party public LCD/rpc server? 
+
+There are two main reasons:
+
+   - Trust, in a decentralized system, anything controlled by one entity cannot be trusted. So we decided to build with the community.
+   - Limited resources: `Ping Dashboard` will list hundreds of cosmos-based blockchains in the future, and it is impossible for our team to run validators or full nodes for all of them.
+
+
+## Donation
+
+Your donation will help us make better products. Thanks in advance.
+
+ - Address for ERC20: USDC, USDT, ETH
+```
+0x88BFec573Dd3E4b7d2E6BfD4D0D6B11F843F8aa1
 ```

-### Compile and Hot-Reload for Development
+ - You can donate any token in the Cosmos ecosystem: [here](https://ping.pub/coffee)

-```sh
-npm run dev
-```
+> If you are an individual please do not donate more than $10, a cup of coffee means a lot to us.

-### Type-Check, Compile and Minify for Production
+#### Donations from project

-```sh
-npm run build
-```
+- Point Network: 1000USDC and $1000 worth of POINT
+- Bitsong: 50k BTSG
+- IRISnet: 100k IRIS

-### Lint with [ESLint](https://eslint.org/)
+## Hire us
+
+You can hire us by submiting an issue and fund the issue on [IssueHunter](https://issuehunt.io/r/ping-pub/explorer)
+
+
+## Contributors
+
+Developers: @liangping @dingyiming

-```sh
-npm run lint
-```