Browse Source

new readme design (#444)


Co-authored-by: loyalsoldier <10487845+Loyalsoldier@users.noreply.github.com>
Kslr 5 years ago
parent
commit
bb74ef99e2
1 changed files with 21 additions and 16 deletions
  1. 21 16
      README.md

+ 21 - 16
README.md

@@ -1,21 +1,27 @@
-# Project V
+<div>
+  <img width="190" height="210" align="left" src="https://raw.githubusercontent.com/v2fly/v2fly-github-io/master/docs/.vuepress/public/readme-logo.png" alt="V2Ray"/>
+  <br>
+  <h1>Project V</h1>
+  <p>Project V is a set of network tools that helps you to build your own computer network. It secures your network connections and thus protects your privacy.</p>
+</div>
 
-[![GitHub Test Badge][1]][2] [![codecov.io][3]][4] [![GoDoc][5]][6] [![codebeat][7]][8] [![Downloads][9]][10] [![Downloads][11]][12]
+[![GitHub Test Badge](https://github.com/v2fly/v2ray-core/workflows/Test/badge.svg)](https://github.com/v2fly/v2ray-core/actions)
+[![codecov.io](https://codecov.io/gh/v2fly/v2ray-core/branch/master/graph/badge.svg?branch=master)](https://codecov.io/gh/v2fly/v2ray-core?branch=master)
+[![codebeat](https://goreportcard.com/badge/github.com/v2fly/v2ray-core)](https://goreportcard.com/report/github.com/v2fly/v2ray-core)
+[![Downloads](https://img.shields.io/github/downloads/v2fly/v2ray-core/total.svg)](https://github.com/v2fly/v2ray-core/releases/latest)
 
-[1]: https://github.com/v2fly/v2ray-core/workflows/Test/badge.svg "GitHub Test Badge"
-[2]: https://github.com/v2fly/v2ray-core/actions "GitHub Actions Page"
-[3]: https://codecov.io/gh/v2fly/v2ray-core/branch/master/graph/badge.svg?branch=master "Coverage Badge"
-[4]: https://codecov.io/gh/v2fly/v2ray-core?branch=master "Codecov Status"
-[5]: https://godoc.org/v2ray.com/core?status.svg "GoDoc Badge"
-[6]: https://godoc.org/v2ray.com/core "GoDoc"
-[7]: https://goreportcard.com/badge/github.com/v2fly/v2ray-core "Goreportcard Badge"
-[8]: https://goreportcard.com/report/github.com/v2fly/v2ray-core "Goreportcard Result"
-[9]: https://img.shields.io/github/downloads/v2ray/v2ray-core/total.svg "v2ray/v2ray-core downloads count"
-[10]: https://github.com/v2ray/v2ray-core/releases "v2ray/v2ray-core release page"
-[11]: https://img.shields.io/github/downloads/v2fly/v2ray-core/total.svg "v2fly/v2ray-core downloads count"
-[12]: https://github.com/v2fly/v2ray-core/releases "v2fly/v2ray-core release page"
+## Related Links
 
-Project V is a set of network tools that help you to build your own computer network. It secures your network connections and thus protects your privacy. See [our website](https://www.v2fly.org/) for more information.
+- [Documentation](https://www.v2fly.org) and [Newcomer's Instructions](https://www.v2fly.org/guide/start.html)
+- Welcome to translate V2Ray documents via [Transifex](https://www.transifex.com/v2fly/public/)
+
+## Packaging Status
+
+> If you are willing to package V2Ray for other distros/platforms, please let us know or seek for help via [GitHub issues](https://github.com/v2fly/v2ray-core/issues).
+
+[![Packaging status](https://repology.org/badge/vertical-allrepos/v2ray.svg)](https://repology.org/project/v2ray/versions)
+[![Packaging status](https://repology.org/badge/vertical-allrepos/go:v2ray-core.svg)](https://repology.org/project/go:v2ray-core/versions)
+[![Packaging status](https://repology.org/badge/vertical-allrepos/v2ray-core.svg)](https://repology.org/project/v2ray-core/versions)
 
 ## License
 
@@ -27,7 +33,6 @@ This repo relies on the following third-party projects:
 
 - In production:
   - [gorilla/websocket](https://github.com/gorilla/websocket)
-  - [gRPC](https://google.golang.org/grpc)
   - [lucas-clemente/quic-go](https://github.com/lucas-clemente/quic-go)
   - [pires/go-proxyproto](https://github.com/pires/go-proxyproto)
   - [seiflotfy/cuckoofilter](https://github.com/seiflotfy/cuckoofilter)