Chiebot-Mirror
/
grpc
mirror of https://github.com/grpc/grpc.git
8
0
Fork 0
Code Issues Projects Releases Wiki Activity

Format top-level README. (#28610)

Browse Source 
Format with `prettier` in preparation for further changes.
pull/28635/head
Paulo Castello da Costa 3 years ago committed by GitHub
parent 257183f5ec
commit 88ff7f0d3f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 71 additions and 55 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 126
      README.md

126
README.md
Unescape View File

@ -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> <table>
<tr> <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) [![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). To maximize usability, gRPC supports the standard method for adding dependencies
In most languages, the gRPC runtime comes as a package available in a user's language package manager. 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/cpp): follow the instructions under the `src/cpp` directory
* [C#](src/csharp): NuGet package `Grpc` - [C#](src/csharp): NuGet package `Grpc`
* [Dart](https://github.com/grpc/grpc-dart): pub 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` - [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 - [Java](https://github.com/grpc/grpc-java): Use JARs from Maven Central
* [Kotlin](https://github.com/grpc/grpc-kotlin): Use JARs from Maven Central Repository Repository
* [Node](https://github.com/grpc/grpc-node): `npm install grpc` - [Kotlin](https://github.com/grpc/grpc-kotlin): Use JARs from Maven Central
* [Objective-C](src/objective-c): Add `gRPC-ProtoRPC` dependency to podspec Repository
* [PHP](src/php): `pecl install grpc` - [Node](https://github.com/grpc/grpc-node): `npm install grpc`
* [Python](src/python/grpcio): `pip install grpcio` - [Objective-C](src/objective-c): Add `gRPC-ProtoRPC` dependency to podspec
* [Ruby](src/ruby): `gem install grpc` - [PHP](src/php): `pecl install grpc`
* [WebJS](https://github.com/grpc/grpc-web): follow the grpc-web instructions - [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! 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 Please read [How to contribute](CONTRIBUTING.md) which will guide you through
the gRPC codebase. the entire workflow of how to build the source code, how to run the tests, and
The "How to contribute" document also contains info on how the contribution process works and contains best practices for creating contributions. 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) See [gRPC Concepts](CONCEPTS.md)
# About This Repository ## 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). 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:
Libraries in different languages may be in various states of development. We are
| Language | Source | seeking contributions for all of these libraries:
|-------------------------|-------------------------------------|
| Shared C [core library] | [src/core](src/core) | | Language | Source |
| C++ | [src/cpp](src/cpp) | | ----------------------- | ---------------------------------- |
| Ruby | [src/ruby](src/ruby) | | Shared C [core library] | [src/core](src/core) |
| Python | [src/python](src/python) | | C++ | [src/cpp](src/cpp) |
| PHP | [src/php](src/php) | | Ruby | [src/ruby](src/ruby) |
| C# (core library based) | [src/csharp](src/csharp) | | Python | [src/python](src/python) |
| Objective-C | [src/objective-c](src/objective-c) | | PHP | [src/php](src/php) |
| C# (core library based) | [src/csharp](src/csharp) |
| Language | Source repo | | Objective-C | [src/objective-c](src/objective-c) |
|-------------------------|------------------------------------------------------|
| Java | [grpc-java](https://github.com/grpc/grpc-java) | | Language | Source repo |
| Kotlin | [grpc-kotlin](https://github.com/grpc/grpc-kotlin) | | -------------------- | -------------------------------------------------- |
| Go | [grpc-go](https://github.com/grpc/grpc-go) | | Java | [grpc-java](https://github.com/grpc/grpc-java) |
| NodeJS | [grpc-node](https://github.com/grpc/grpc-node) | | Kotlin | [grpc-kotlin](https://github.com/grpc/grpc-kotlin) |
| WebJS | [grpc-web](https://github.com/grpc/grpc-web) | | Go | [grpc-go](https://github.com/grpc/grpc-go) |
| Dart | [grpc-dart](https://github.com/grpc/grpc-dart) | | NodeJS | [grpc-node](https://github.com/grpc/grpc-node) |
| .NET (pure C# impl.) | [grpc-dotnet](https://github.com/grpc/grpc-dotnet) | | 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) |

Write Preview
Loading…
Cancel
Save