README.md

   1 gRPC - An RPC library and framework
   2 ===================================
   3
   4 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.
   5
   6 <table>
   7   <tr>
   8     <td><b>Homepage:</b></td>
   9     <td><a href="https://grpc.io/">grpc.io</a></td>
  10   </tr>
  11   <tr>
  12     <td><b>Mailing List:</b></td>
  13     <td><a href="https://groups.google.com/forum/#!forum/grpc-io">grpc-io@googlegroups.com</a></td>
  14   </tr>
  15 </table>
  16
  17 [![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)
  18
  19 # To start using gRPC
  20
  21 To maximize usability, gRPC supports the standard method for adding dependencies to a user's chosen language (if there is one).
  22 In most languages, the gRPC runtime comes as a package available in a user's language package manager.
  23
  24 For instructions on how to use the language-specific gRPC runtime for a project, please refer to these documents
  25
  26  * [C++](src/cpp): follow the instructions under the `src/cpp` directory
  27  * [C#](src/csharp): NuGet package `Grpc`
  28  * [Dart](https://github.com/grpc/grpc-dart): pub package `grpc`
  29  * [Go](https://github.com/grpc/grpc-go): `go get google.golang.org/grpc`
  30  * [Java](https://github.com/grpc/grpc-java): Use JARs from Maven Central Repository
  31  * [Kotlin](https://github.com/grpc/grpc-kotlin): Use JARs from Maven Central Repository
  32  * [Node](https://github.com/grpc/grpc-node): `npm install grpc`
  33  * [Objective-C](src/objective-c): Add `gRPC-ProtoRPC` dependency to podspec
  34  * [PHP](src/php): `pecl install grpc`
  35  * [Python](src/python/grpcio): `pip install grpcio`
  36  * [Ruby](src/ruby): `gem install grpc`
  37  * [WebJS](https://github.com/grpc/grpc-web): follow the grpc-web instructions
  38
  39 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.
  40
  41 Precompiled bleeding-edge package builds of gRPC `master` branch's `HEAD` are uploaded daily to [packages.grpc.io](https://packages.grpc.io).
  42
  43 # To start developing gRPC
  44
  45 Contributions are welcome!
  46
  47 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
  48 the gRPC codebase.
  49 The "How to contribute" document also contains info on how the contribution process works and contains best practices for creating contributions.
  50
  51 # Troubleshooting
  52
  53 Sometimes things go wrong. Please check out the [Troubleshooting guide](TROUBLESHOOTING.md) if you are experiencing issues with gRPC.
  54
  55 # Performance
  56
  57 See the [Performance dashboard](https://performance-dot-grpc-testing.appspot.com/explore?dashboard=5652536396611584) for performance numbers of master branch daily builds.
  58
  59 # Concepts
  60
  61 See [gRPC Concepts](CONCEPTS.md)
  62
  63 # About This Repository
  64
  65 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).
  66
  67 Libraries in different languages may be in various states of development. We are seeking contributions for all of these libraries:
  68
  69 | Language                | Source                              |
  70 |-------------------------|-------------------------------------|
  71 | Shared C [core library] | [src/core](src/core)                |
  72 | C++                     | [src/cpp](src/cpp)                  |
  73 | Ruby                    | [src/ruby](src/ruby)                |
  74 | Python                  | [src/python](src/python)            |
  75 | PHP                     | [src/php](src/php)                  |
  76 | C# (core library based) | [src/csharp](src/csharp)            |
  77 | Objective-C             | [src/objective-c](src/objective-c)  |
  78
  79 | Language                | Source repo                                          |
  80 |-------------------------|------------------------------------------------------|
  81 | Java                    | [grpc-java](https://github.com/grpc/grpc-java)       |
  82 | Kotlin                  | [grpc-kotlin](https://github.com/grpc/grpc-kotlin)   |
  83 | Go                      | [grpc-go](https://github.com/grpc/grpc-go)           |
  84 | NodeJS                  | [grpc-node](https://github.com/grpc/grpc-node)       |
  85 | WebJS                   | [grpc-web](https://github.com/grpc/grpc-web)         |
  86 | Dart                    | [grpc-dart](https://github.com/grpc/grpc-dart)       |
  87 | .NET (pure C# impl.)    | [grpc-dotnet](https://github.com/grpc/grpc-dotnet)   |