Skip to content

Commit f6c9bf9

Browse files
committed
add readme
1 parent 9ade013 commit f6c9bf9

File tree

2 files changed

+41
-0
lines changed

2 files changed

+41
-0
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Want to contribute? Great! First, read this page (including the small print at the end).
2+
3+
### Before you contribute
4+
Before we can use your code, you must sign the
5+
[Google Individual Contributor License Agreement]
6+
(https://cla.developers.google.com/about/google-individual)
7+
(CLA), which you can do online. The CLA is necessary mainly because you own the
8+
copyright to your changes, even after your contribution becomes part of our
9+
codebase, so we need your permission to use and distribute your code. We also
10+
need to be sure of various other things—for instance that you'll tell us if you
11+
know that your code infringes on other people's patents. You don't have to sign
12+
the CLA until after you've submitted your code for review and a member has
13+
approved it, but you must do it before we can put your code into our codebase.
14+
Before you start working on a larger contribution, you should get in touch with
15+
us first through the issue tracker with your idea so that we can help out and
16+
possibly guide you. Coordinating up front makes it much easier to avoid
17+
frustration later on.
18+
19+
### Code reviews
20+
All submissions, including submissions by project members, require review. We
21+
use Github pull requests for this purpose.
22+
23+
### The small print
24+
Contributions made by corporations are covered by a different agreement than
25+
the one above, the
26+
[Software Grant and Corporate Contributor License Agreement]
27+
(https://cla.developers.google.com/about/google-corporate).

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# grpc-transcoding
2+
3+
grpc-transcoding is a library that supports [transcoding](https://cloud.google.com/endpoints/docs/transcoding) so that HTTP/JSON can be converted to gRPC.
4+
5+
It helps you to provide your APIs in both gRPC and RESTful style at the same time. The code is used in istio [proxy](https://github.com/istio/proxy)
6+
to provide HTTP+JSON interface to gRPC service.
7+
8+
# Contribution
9+
See [CONTRIBUTING.md](http://github.com/grpc-ecosystem/grpc-transcoding/blob/master/CONTRIBUTING.md).
10+
11+
# License
12+
grpc-transcoding is licensed under the Apache 2.0 license.
13+
See [LICENSE.txt](https://github.com/grpc-ecosystem/grpc-transcoding/blob/master/LICENSE.txt) for more details.
14+

0 commit comments

Comments
 (0)