Skip to content

Commit 9071f0b

Browse files
committed
Improve README, minor fixes in WORKSPACE
1 parent 0dbb526 commit 9071f0b

File tree

3 files changed

+18
-22
lines changed

3 files changed

+18
-22
lines changed

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,29 @@
11
# grpc-transcoding
22

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.
3+
grpc-transcoding is a library that supports [transcoding]
4+
(https://github.com/googleapis/googleapis/blob/master/google/api/http.proto)
5+
so that HTTP/JSON can be converted to gRPC.
46

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) to provide HTTP+JSON interface to gRPC service.
7+
It helps you to provide your APIs in both gRPC and RESTful style at the same
8+
time. The code is used in istio [proxy](https://github.com/istio/proxy) and
9+
cloud [endpoints](https://cloud.google.com/endpoints/) to provide HTTP+JSON
10+
interface to gRPC service.
611

7-
The code can be built with the following command
812

9-
bazel build //...
13+
## Develop
1014

11-
Tests can be run using
15+
[Bazel](https://bazel.build/) is used for build and dependency management. The
16+
following commands build and test sources:
1217

13-
bazel test //...
18+
```bash
19+
$ bazel build //...
20+
$ bazel test //...
21+
```
1422

1523
# Contribution
16-
See [CONTRIBUTING.md](http://github.com/grpc-ecosystem/grpc-transcoding/blob/master/CONTRIBUTING.md).
24+
See [CONTRIBUTING.md](CONTRIBUTING.md).
1725

1826
# License
19-
grpc-transcoding is licensed under the Apache 2.0 license.
20-
See [LICENSE](https://github.com/grpc-ecosystem/grpc-transcoding/blob/master/LICENSE) for more details.
27+
grpc-httpjson-transcoding is licensed under the Apache 2.0 license. See
28+
[LICENSE](LICENSE)for more details.
2129

WORKSPACE

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
#
1717

1818
load(
19-
"//src:repositories.bzl",
19+
"//:repositories.bzl",
2020
"protobuf_repositories",
2121
"googletest_repositories",
2222
"googleapis_repositories",
@@ -27,15 +27,3 @@ protobuf_repositories()
2727
googletest_repositories()
2828

2929
googleapis_repositories()
30-
31-
# Workaround for Bazel > 0.4.0 since it needs newer protobuf.bzl from:
32-
# https://github.com/google/protobuf/pull/2246
33-
# Do not use this git_repository for anything else than protobuf.bzl
34-
new_git_repository(
35-
name = "protobuf_bzl",
36-
# Injecting an empty BUILD file to prevent using any build target
37-
build_file_content = "",
38-
commit = "05090726144b6e632c50f47720ff51049bfcbef6",
39-
remote = "https://github.com/google/protobuf.git",
40-
)
41-
File renamed without changes.

0 commit comments

Comments
 (0)