From 580e976b5fb23cc394d710a511d896f75fc9ce31 Mon Sep 17 00:00:00 2001 From: Jan Tattermusch Date: Wed, 12 Oct 2016 17:42:55 +0200 Subject: [PATCH 01/10] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e9b0454871c..70cf9fcc30e 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 | |-------------------------|-------------------------------------|---------| From 10edbe5485add0cb1b1e4b71045d783f1a1ed3b8 Mon Sep 17 00:00:00 2001 From: Jan Tattermusch Date: Wed, 12 Oct 2016 17:48:59 +0200 Subject: [PATCH 02/10] Update README.md --- src/core/README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/src/core/README.md b/src/core/README.md index 0d8c0d5bd90..62865d0c13e 100644 --- a/src/core/README.md +++ b/src/core/README.md @@ -2,7 +2,3 @@ This directory contains source code for shared C library. Libraries in other languages in this repository (C++, Ruby, Python, PHP, NodeJS, Objective-C) are layered on top of this library. - -#Status - -Beta From 7a82301a2ea55fd534bb0e43c68c0d7e94878dff Mon Sep 17 00:00:00 2001 From: Jan Tattermusch Date: Wed, 12 Oct 2016 17:55:57 +0200 Subject: [PATCH 03/10] Update README.md --- src/core/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/core/README.md b/src/core/README.md index 62865d0c13e..44c6f247725 100644 --- a/src/core/README.md +++ b/src/core/README.md @@ -1,4 +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. From 5b2e172e5785bcd73c425192ca3d670a96044d27 Mon Sep 17 00:00:00 2001 From: Jan Tattermusch Date: Wed, 12 Oct 2016 18:00:39 +0200 Subject: [PATCH 04/10] Create README.md --- src/compiler/README.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 src/compiler/README.md diff --git a/src/compiler/README.md b/src/compiler/README.md new file mode 100644 index 00000000000..a2f49b3cd53 --- /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. From 9cece7ca992c6594ed163dc9996a3f879f3d7a1f Mon Sep 17 00:00:00 2001 From: Jan Tattermusch Date: Wed, 12 Oct 2016 18:01:41 +0200 Subject: [PATCH 05/10] Update README.md --- src/cpp/README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/src/cpp/README.md b/src/cpp/README.md index 8c0f85e5ff7..d9b521317a6 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 From 9633bd356f2fd90c1bccf0be58f406316155ca54 Mon Sep 17 00:00:00 2001 From: Jan Tattermusch Date: Wed, 12 Oct 2016 18:02:32 +0200 Subject: [PATCH 06/10] Update README.md --- src/csharp/README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/src/csharp/README.md b/src/csharp/README.md index 18d5945a8a1..a04172dad4f 100644 --- a/src/csharp/README.md +++ b/src/csharp/README.md @@ -4,11 +4,6 @@ gRPC C# A C# implementation of gRPC. -Status ------- - -Beta - PREREQUISITES -------------- From d1395d9a667b43807b6f068eff06f4fb53cf43d0 Mon Sep 17 00:00:00 2001 From: Jan Tattermusch Date: Wed, 12 Oct 2016 18:03:00 +0200 Subject: [PATCH 07/10] Update README.md --- src/node/README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/node/README.md b/src/node/README.md index 15d4c6d02f7..fc407435cd7 100644 --- a/src/node/README.md +++ b/src/node/README.md @@ -1,9 +1,6 @@ [![npm](https://img.shields.io/npm/v/grpc.svg)](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. From 45775fd8a13a4a92310739672d6eba29a8e8e0e6 Mon Sep 17 00:00:00 2001 From: Jan Tattermusch Date: Wed, 12 Oct 2016 18:03:47 +0200 Subject: [PATCH 08/10] Update README.md --- src/php/README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/src/php/README.md b/src/php/README.md index 7e9819b256d..f2ad96f7a89 100644 --- a/src/php/README.md +++ b/src/php/README.md @@ -3,10 +3,6 @@ This directory contains source code for PHP implementation of gRPC layered on shared C library. -#Status - -GA - ## Environment Prerequisite: From 5d77c964fc881df3f8c2f2cff274b46134d48943 Mon Sep 17 00:00:00 2001 From: Jan Tattermusch Date: Wed, 12 Oct 2016 18:04:37 +0200 Subject: [PATCH 09/10] Update README.md --- src/ruby/README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/src/ruby/README.md b/src/ruby/README.md index 31795754866..a4d7b56b4ec 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 ------------- From 0dc8d354e9546bb15fd5b3342637ed8b1d1cd10d Mon Sep 17 00:00:00 2001 From: Jan Tattermusch Date: Wed, 12 Oct 2016 18:22:39 +0200 Subject: [PATCH 10/10] Update README.md --- src/csharp/README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/src/csharp/README.md b/src/csharp/README.md index a04172dad4f..0405ff88a01 100644 --- a/src/csharp/README.md +++ b/src/csharp/README.md @@ -4,6 +4,14 @@ gRPC C# A C# implementation of gRPC. +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 + + PREREQUISITES -------------- @@ -11,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 -------------- @@ -64,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][] @@ -97,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