Format top-level README. (#28610)

Format with `prettier` in preparation for further changes.
3 years ago · 88ff7f0d3f
parent 257183f5ec
commit 88ff7f0d3f
1 changed files with 71 additions and 55 deletions
--- a/README.md
+++ b/README.md
@ -1,7 +1,8 @@
-gRPC - An RPC library and framework
-===================================
+# gRPC – An RPC library and framework

-gRPC is a modern, open source, high-performance remote procedure call (RPC) framework that can run anywhere. gRPC enables client and server applications to communicate transparently, and simplifies the building of connected systems.
+gRPC is a modern, open source, high-performance remote procedure call (RPC)
+framework that can run anywhere. gRPC enables client and server applications to
+communicate transparently, and simplifies the building of connected systems.

 <table>
  <tr>
@ -16,72 +17,87 @@ gRPC is a modern, open source, high-performance remote procedure call (RPC) fram

 [![Join the chat at https://gitter.im/grpc/grpc](https://badges.gitter.im/grpc/grpc.svg)](https://gitter.im/grpc/grpc?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

-# To start using gRPC
+## To start using gRPC

-To maximize usability, gRPC supports the standard method for adding dependencies to a user's chosen language (if there is one).
-In most languages, the gRPC runtime comes as a package available in a user's language package manager.
+To maximize usability, gRPC supports the standard method for adding dependencies
+to a user's chosen language (if there is one). In most languages, the gRPC
+runtime comes as a package available in a user's language package manager.

-For instructions on how to use the language-specific gRPC runtime for a project, please refer to these documents
+For instructions on how to use the language-specific gRPC runtime for a project,
+please refer to these documents

- * [C++](src/cpp): follow the instructions under the `src/cpp` directory
- * [C#](src/csharp): NuGet package `Grpc`
- * [Dart](https://github.com/grpc/grpc-dart): pub package `grpc`
- * [Go](https://github.com/grpc/grpc-go): `go get google.golang.org/grpc`
- * [Java](https://github.com/grpc/grpc-java): Use JARs from Maven Central Repository
- * [Kotlin](https://github.com/grpc/grpc-kotlin): Use JARs from Maven Central Repository
- * [Node](https://github.com/grpc/grpc-node): `npm install grpc`
- * [Objective-C](src/objective-c): Add `gRPC-ProtoRPC` dependency to podspec
- * [PHP](src/php): `pecl install grpc`
- * [Python](src/python/grpcio): `pip install grpcio`
- * [Ruby](src/ruby): `gem install grpc`
- * [WebJS](https://github.com/grpc/grpc-web): follow the grpc-web instructions
+- [C++](src/cpp): follow the instructions under the `src/cpp` directory
+- [C#](src/csharp): NuGet package `Grpc`
+- [Dart](https://github.com/grpc/grpc-dart): pub package `grpc`
+- [Go](https://github.com/grpc/grpc-go): `go get google.golang.org/grpc`
+- [Java](https://github.com/grpc/grpc-java): Use JARs from Maven Central
+  Repository
+- [Kotlin](https://github.com/grpc/grpc-kotlin): Use JARs from Maven Central
+  Repository
+- [Node](https://github.com/grpc/grpc-node): `npm install grpc`
+- [Objective-C](src/objective-c): Add `gRPC-ProtoRPC` dependency to podspec
+- [PHP](src/php): `pecl install grpc`
+- [Python](src/python/grpcio): `pip install grpcio`
+- [Ruby](src/ruby): `gem install grpc`
+- [WebJS](https://github.com/grpc/grpc-web): follow the grpc-web instructions

-Per-language quickstart guides and tutorials can be found in the [documentation section on the grpc.io website](https://grpc.io/docs/). Code examples are available in the [examples](examples) directory.
+Per-language quickstart guides and tutorials can be found in the
+[documentation section on the grpc.io website](https://grpc.io/docs/). Code
+examples are available in the [examples](examples) directory.

-Precompiled bleeding-edge package builds of gRPC `master` branch's `HEAD` are uploaded daily to [packages.grpc.io](https://packages.grpc.io).
+Precompiled bleeding-edge package builds of gRPC `master` branch's `HEAD` are
+uploaded daily to [packages.grpc.io](https://packages.grpc.io).

-# To start developing gRPC
+## To start developing gRPC

 Contributions are welcome!

-Please read [How to contribute](CONTRIBUTING.md) which will guide you through the entire workflow of how to build the source code, how to run the tests, and how to contribute changes to
-the gRPC codebase.
-The "How to contribute" document also contains info on how the contribution process works and contains best practices for creating contributions.
+Please read [How to contribute](CONTRIBUTING.md) which will guide you through
+the entire workflow of how to build the source code, how to run the tests, and
+how to contribute changes to the gRPC codebase. The "How to contribute" document
+also contains info on how the contribution process works and contains best
+practices for creating contributions.

-# Troubleshooting
+## Troubleshooting

-Sometimes things go wrong. Please check out the [Troubleshooting guide](TROUBLESHOOTING.md) if you are experiencing issues with gRPC.
+Sometimes things go wrong. Please check out the
+[Troubleshooting guide](TROUBLESHOOTING.md) if you are experiencing issues with
+gRPC.

-# Performance 
+## Performance

-See the [Performance dashboard](https://performance-dot-grpc-testing.appspot.com/explore?dashboard=5180705743044608) for performance numbers of master branch daily builds.
+See the
+[Performance dashboard](https://performance-dot-grpc-testing.appspot.com/explore?dashboard=5180705743044608)
+for performance numbers of master branch daily builds.

-# Concepts
+## Concepts

 See [gRPC Concepts](CONCEPTS.md)

-# About This Repository
-
-This repository contains source code for gRPC libraries implemented in multiple languages written on top of a shared C core library [src/core](src/core).
-
-Libraries in different languages may be in various states of development. We are seeking contributions for all of these libraries:
-
-| Language                | Source                              |
-|-------------------------|-------------------------------------|
-| Shared C [core library] | [src/core](src/core)                |
-| C++                     | [src/cpp](src/cpp)                  |
-| Ruby                    | [src/ruby](src/ruby)                |
-| Python                  | [src/python](src/python)            |
-| PHP                     | [src/php](src/php)                  |
-| C# (core library based) | [src/csharp](src/csharp)            |
-| Objective-C             | [src/objective-c](src/objective-c)  |
-
-| Language                | Source repo                                          |
-|-------------------------|------------------------------------------------------|
-| Java                    | [grpc-java](https://github.com/grpc/grpc-java)       |
-| Kotlin                  | [grpc-kotlin](https://github.com/grpc/grpc-kotlin)   |
-| Go                      | [grpc-go](https://github.com/grpc/grpc-go)           |
-| NodeJS                  | [grpc-node](https://github.com/grpc/grpc-node)       |
-| WebJS                   | [grpc-web](https://github.com/grpc/grpc-web)         |
-| Dart                    | [grpc-dart](https://github.com/grpc/grpc-dart)       |
-| .NET (pure C# impl.)    | [grpc-dotnet](https://github.com/grpc/grpc-dotnet)   |
+## About This Repository
+
+This repository contains source code for gRPC libraries implemented in multiple
+languages written on top of a shared C core library [src/core](src/core).
+
+Libraries in different languages may be in various states of development. We are
+seeking contributions for all of these libraries:
+
+| Language                | Source                             |
+| ----------------------- | ---------------------------------- |
+| Shared C [core library] | [src/core](src/core)               |
+| C++                     | [src/cpp](src/cpp)                 |
+| Ruby                    | [src/ruby](src/ruby)               |
+| Python                  | [src/python](src/python)           |
+| PHP                     | [src/php](src/php)                 |
+| C# (core library based) | [src/csharp](src/csharp)           |
+| Objective-C             | [src/objective-c](src/objective-c) |
+
+| Language             | Source repo                                        |
+| -------------------- | -------------------------------------------------- |
+| Java                 | [grpc-java](https://github.com/grpc/grpc-java)     |
+| Kotlin               | [grpc-kotlin](https://github.com/grpc/grpc-kotlin) |
+| Go                   | [grpc-go](https://github.com/grpc/grpc-go)         |
+| NodeJS               | [grpc-node](https://github.com/grpc/grpc-node)     |
+| WebJS                | [grpc-web](https://github.com/grpc/grpc-web)       |
+| Dart                 | [grpc-dart](https://github.com/grpc/grpc-dart)     |
+| .NET (pure C# impl.) | [grpc-dotnet](https://github.com/grpc/grpc-dotnet) |