From 974e8d5d683edf4d280ad37238be58765b5f086b Mon Sep 17 00:00:00 2001 From: Masood Malekghassemi Date: Mon, 14 Dec 2015 18:34:58 -0800 Subject: Add an inventory of top-level items --- INVENTORY.md | 13 +++++++++++++ README.md | 14 ++++++++------ 2 files changed, 21 insertions(+), 6 deletions(-) create mode 100644 INVENTORY.md diff --git a/INVENTORY.md b/INVENTORY.md new file mode 100644 index 0000000000..7da7f9253c --- /dev/null +++ b/INVENTORY.md @@ -0,0 +1,13 @@ +# Top-level Items by language + +## Node +* [binding.gyp](binding.gyp) + +## Objective-C +* [gRPC.podspec](gRPC.podspec) + +## Python +* [requirements.txt](requirements.txt) +* [setup.cfg](setup.cfg) +* [setup.py](setup.py) +* [tox.ini](tox.ini) diff --git a/README.md b/README.md index 9701930547..ebbc36487b 100644 --- a/README.md +++ b/README.md @@ -11,16 +11,16 @@ You can find more detailed documentation and examples in the [doc](doc) and [exa #Installation -See grpc/INSTALL for installation instructions for various platforms. +See [grpc/INSTALL](INSTALL) for installation instructions for various platforms. #Repository Structure & Status 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 state of development. We are seeking contributions for all of these libraries. +Libraries in different languages are in different states of development. We are seeking contributions for all of these libraries. -| Language | Source | Status | -|-------------------------|-------------------------------------|---------------------------------| +| Language | Source | Status | +|-------------------------|-------------------------------------|----------------------------------| | Shared C [core library] | [src/core] (src/core) | Beta - the surface API is stable | | C++ | [src/cpp] (src/cpp) | Beta - the surface API is stable | | Ruby | [src/ruby] (src/ruby) | Beta - the surface API is stable | @@ -31,10 +31,12 @@ Libraries in different languages are in different state of development. We are s | Objective-C | [src/objective-c] (src/objective-c) | Beta - the surface API is stable | -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. +Java source code is in the [grpc-java] (http://github.com/grpc/grpc-java) repository. +Go source code is in the [grpc-go] (http://github.com/grpc/grpc-go) repository. +See [INVENTORY.md](INVENTORY.md) for a listing of top-level items in the +repository. #Overview -- cgit v1.2.3