diff options
author | Jan Tattermusch <jtattermusch@users.noreply.github.com> | 2016-10-12 18:34:10 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-10-12 18:34:10 +0200 |
commit | 40b80f0c90c4451e88d11cb6f34fa52523d657cf (patch) | |
tree | a80b9433105ba5845a58b7c4a80103d9186d2894 | |
parent | 52fd9f1119a95b6f22366551c0b2154b776f4aa7 (diff) | |
parent | 0dc8d354e9546bb15fd5b3342637ed8b1d1cd10d (diff) |
Merge pull request #8353 from jtattermusch/v1.0.x
Several improvements to README.md files
-rw-r--r-- | README.md | 2 | ||||
-rw-r--r-- | src/compiler/README.md | 4 | ||||
-rw-r--r-- | src/core/README.md | 6 | ||||
-rw-r--r-- | src/cpp/README.md | 4 | ||||
-rw-r--r-- | src/csharp/README.md | 20 | ||||
-rw-r--r-- | src/node/README.md | 3 | ||||
-rw-r--r-- | src/php/README.md | 4 | ||||
-rw-r--r-- | src/ruby/README.md | 5 |
8 files changed, 14 insertions, 34 deletions
@@ -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 0000000000..a2f49b3cd5 --- /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 0d8c0d5bd9..44c6f24772 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 8c0f85e5ff..d9b521317a 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 18d5945a8a..0405ff88a0 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 15d4c6d02f..fc407435cd 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. diff --git a/src/php/README.md b/src/php/README.md index 7e9819b256..f2ad96f7a8 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: diff --git a/src/ruby/README.md b/src/ruby/README.md index 3179575486..a4d7b56b4e 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 ------------- |