diff --git a/README.md b/README.md index e9b0454871c9df85dcc2549caaf0cdc287ae9414..70cf9fcc30e2e4f00d42480adb74412d94b2a0f9 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ See [tools/run_tests](tools/run_tests) for more guidance on how to run various t This repository contains source code for gRPC libraries for multiple languages written on top of shared C core library [src/core] (src/core). -Libraries in different languages are in different states of development. We are seeking contributions for all of these libraries. +Libraries in different languages may be in different states of development. We are seeking contributions for all of these libraries. | Language | Source | Status | |-------------------------|-------------------------------------|---------| diff --git a/src/compiler/README.md b/src/compiler/README.md new file mode 100644 index 0000000000000000000000000000000000000000..a2f49b3cd5387f90595ac6b77458b67d1b6a15c4 --- /dev/null +++ b/src/compiler/README.md @@ -0,0 +1,4 @@ +#Overview + +This directory contains source code for gRPC protocol buffer compiler (*protoc*) plugins. Along with `protoc`, +these plugins are used to generate gRPC client and server stubs from `.proto` files. diff --git a/src/core/README.md b/src/core/README.md index 0d8c0d5bd90847ef520918ab1dac363a689e02aa..44c6f247725896b9667c02befcb22e2b4ef34308 100644 --- a/src/core/README.md +++ b/src/core/README.md @@ -1,8 +1,4 @@ #Overview -This directory contains source code for shared C library. Libraries in other languages in this repository (C++, Ruby, +This directory contains source code for C library (a.k.a the *gRPC C core*) that provides all gRPC's core functionality through a low level API. Libraries in other languages in this repository (C++, Ruby, Python, PHP, NodeJS, Objective-C) are layered on top of this library. - -#Status - -Beta diff --git a/src/cpp/README.md b/src/cpp/README.md index 8c0f85e5ff795445478c9dc56d227dbc1f14d2be..d9b521317a6ca18f9b8a7fe5e706a9792b0a97e9 100644 --- a/src/cpp/README.md +++ b/src/cpp/README.md @@ -3,10 +3,6 @@ This directory contains source code for C++ implementation of gRPC. -#Status - -Beta - #Pre-requisites ##Linux diff --git a/src/csharp/README.md b/src/csharp/README.md index 18d5945a8a1ac53868c271021eeaab5da6cad1a2..0405ff88a01c81e3fdfcccebbcf674e5b80f7975 100644 --- a/src/csharp/README.md +++ b/src/csharp/README.md @@ -4,10 +4,13 @@ gRPC C# A C# implementation of gRPC. -Status ------- +SUPPORTED PLATFORMS +------------------ + +- .NET Framework 4.5+ (Windows) +- [.NET Core](https://dotnet.github.io/) on Linux, Windows and Mac OS X (starting from version 1.0.1) +- Mono 4+ on Linux, Windows and Mac OS X -Beta PREREQUISITES -------------- @@ -16,6 +19,7 @@ PREREQUISITES - Linux: Mono 4+, MonoDevelop 5.9+ (with NuGet add-in installed) - Mac OS X: Xamarin Studio 5.9+ + HOW TO USE -------------- @@ -69,12 +73,6 @@ different languages. tools/run_tests/run_tests.py -l csharp ``` -ON .NET CORE SUPPORT ------------------- - -We are committed to providing full support for [.NET Core](https://dotnet.github.io/) in near future, -but currently, the support is for .NET Core is experimental/work-in-progress. - DOCUMENTATION ------------- - [API Reference][] @@ -102,9 +100,7 @@ CONTENTS THE NATIVE DEPENDENCY --------------- -Internally, gRPC C# uses a native library written in C (gRPC C core) and invokes its functionality via P/Invoke. `grpc_csharp_ext` library is a native extension library that facilitates this by wrapping some C core API into a form that's more digestible for P/Invoke. - -Prior to version 0.13, installing `grpc_csharp_ext` was required to make gRPC work on Linux and MacOS. Starting with version 0.13, we have improved the packaging story significantly and precompiled versions of the native library for all supported platforms are now shipped with the NuGet package. Just installing the `Grpc` NuGet package should be the only step needed to use gRPC C#, regardless of your platform (Windows, Linux or Mac) and the bitness (32 or 64bit). +Internally, gRPC C# uses a native library written in C (gRPC C core) and invokes its functionality via P/Invoke. The fact that a native library is used should be fully transparent to the users and just installing the `Grpc.Core` NuGet package is the only step needed to use gRPC C# on all supported platforms. [API Reference]: http://www.grpc.io/grpc/csharp/ [Helloworld Example]: ../../examples/csharp/helloworld diff --git a/src/node/README.md b/src/node/README.md index 9eafce924354c7fbbba9bcc45f915340660ed991..4b906643bc0eae283d86aa4d0bc0a647395f08ab 100644 --- a/src/node/README.md +++ b/src/node/README.md @@ -1,9 +1,6 @@ [](https://www.npmjs.com/package/grpc) # Node.js gRPC Library -## Status -Beta - ## PREREQUISITES - `node`: This requires `node` to be installed, version `0.12` or above. If you instead have the `nodejs` executable on Debian, you should install the [`nodejs-legacy`](https://packages.debian.org/sid/nodejs-legacy) package. diff --git a/src/php/README.md b/src/php/README.md index 0e5b4de31e316a90d074832b3ae1b763dccf1ed4..1b15768d44a1d913b6a28e257ac642d2e38040df 100644 --- a/src/php/README.md +++ b/src/php/README.md @@ -4,10 +4,6 @@ This directory contains source code for PHP implementation of gRPC layered on shared C library. -#Status - -GA - ## Environment **Prerequisite:** diff --git a/src/ruby/README.md b/src/ruby/README.md index 67e94dd35404e3a8110bcff0eab86563ffe0d3b7..f476fe72be2fecc1ef2c9f2438e41dd19772f109 100644 --- a/src/ruby/README.md +++ b/src/ruby/README.md @@ -4,11 +4,6 @@ gRPC Ruby A Ruby implementation of gRPC. -Status ------- - -Beta - PREREQUISITES -------------