diff --git a/README.md b/README.md index 2b049d206bd46e47e8a9a7e68d24fde48143cf6a..1985176753626792605e39dfbfcaeac76444dccf 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,27 @@ of shared C core library [src/core] (src/core). * NodeJS source code: [src/node] (src/node) * PHP source code: [src/php] (src/php) * C# source code: [src/csharp] (src/csharp) + * Objective-C source code: [src/objective-c] (src/objective-c) Java source code is in [grpc-java] (http://github.com/grpc/grpc-java) repository. Go source code is in [grpc-go] (http://github.com/grpc/grpc-go) repository. +#Documentation + +You can find more detailed documentation and examples in the [grpc-common repository](http://github.com/grpc/grpc-common). + +#Current Status of libraries + +Libraries in different languages are in different state of development. We are seeking contributions for all of these libraries. + + * shared C core library [src/core] (src/core) : Early adopter ready - Alpha. + * C++ Library: [src/cpp] (src/cpp) : Early adopter ready - Alpha. + * Python Library: [src/python] (src/python) : Early adopter ready - Alpha. + * Ruby Library: [src/ruby] (src/ruby) : Early adopter ready - Alpha. + * NodeJS Library: [src/node] (src/node) : Early adopter ready - Alpha. + * PHP Library: [src/php] (src/php) : Pre-Alpha. + * C# Library: [src/csharp] (src/csharp) : Pre-Alpha. + * Objective-C Library: [src/objective-c] (src/objective-c): Pre-Alpha. #Overview diff --git a/src/core/README.md b/src/core/README.md new file mode 100644 index 0000000000000000000000000000000000000000..407dc4f70191b5aae336c2cb079238cb35327768 --- /dev/null +++ b/src/core/README.md @@ -0,0 +1,9 @@ +#Overview + +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 + +Alpha : Ready for early adopters + diff --git a/src/cpp/README.md b/src/cpp/README.md new file mode 100644 index 0000000000000000000000000000000000000000..a2eb9a08c81ec5930e79b15d9ce7812d50153928 --- /dev/null +++ b/src/cpp/README.md @@ -0,0 +1,9 @@ + +#Overview + +This directory contains source code for C++ implementation of gRPC. + +#Status + +Alpha : Ready for early adopters + diff --git a/src/csharp/README.md b/src/csharp/README.md index fdc6f680416885a5bd0c1e366b5d3e1b9b5f8d59..9967af22b3bc4dbdeff853dc8b7297a11bd33c95 100755 --- a/src/csharp/README.md +++ b/src/csharp/README.md @@ -3,7 +3,7 @@ gRPC C# A C# implementation of gRPC. -EXPERIMENTAL ONLY +Status ----------------- **This gRPC C# implementation is work-in-progress and is not expected to work yet.** diff --git a/src/node/README.md b/src/node/README.md index c342b7ca575cc325f29b122a364e701b47cc1cf2..8880213e9a9a6585f59a0ba8a5ad1734f6c9278e 100644 --- a/src/node/README.md +++ b/src/node/README.md @@ -1,5 +1,9 @@ # Node.js gRPC Library +## Status + +Alpha : Ready for early adopters + ## Installation First, clone this repository (NPM package coming soon). Then follow the instructions in the `INSTALL` file in the root of the repository to install the C core library that this package depends on. diff --git a/src/php/README.md b/src/php/README.md index 620c68fd7b5feb7b0f4d5545f48d62117e082edc..40c79e0dd4003115c71234df4ea885c46df0ee71 100755 --- a/src/php/README.md +++ b/src/php/README.md @@ -1,4 +1,12 @@ -# PHP wrapper for the GRPC interfaces. + +#Overview + +This directory contains source code for PHP implementation of gRPC layered on shared C library. + +#Status + +Pre-Alpha : This gRPC PHP implementation is work-in-progress and is not expected to work yet. + ## LAYOUT diff --git a/src/ruby/README.md b/src/ruby/README.md index 42f307aa5d57702582c241c26c0150355e57e615..6e0e9db4a3cfe5bc67343635c5ae7052a2bf8834 100755 --- a/src/ruby/README.md +++ b/src/ruby/README.md @@ -3,6 +3,10 @@ gRPC Ruby A Ruby implementation of gRPC. +Status +------- + +Alpha : Ready for early adopters INSTALLATION PREREQUISITES --------------------------