Skip to content

Commit

Permalink
Update README.md (#240)
Browse files Browse the repository at this point in the history
  • Loading branch information
bufdev authored May 31, 2022
1 parent 2c76648 commit 03661b5
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,13 @@ and Connect's own protocol.
The [Connect protocol][protocol] is a simple, POST-only protocol that works
over HTTP/1.1 or HTTP/2. It takes the best portions of gRPC and gRPC-Web,
including streaming, and packages them into a protocol that works equally well
in browsers, monoliths, and microservices. Calling a Connect API is a cURL
one-liner:
in browsers, monoliths, and microservices. Calling a Connect API is as easy as
using `curl`:

```
$ curl --header "Content-Type: application/json" \
# Try it out! This is a live demo!
$ curl \
--header "Content-Type: application/json" \
--data '{"sentence": "I feel happy."}' \
https://demo.connectrpc.com/buf.connect.demo.eliza.v1.ElizaService/Say
Expand All @@ -32,7 +34,9 @@ reflection][] and [health checks][] are available as standalone packages.
Instead of cURL, we could call our API with `grpcurl`:

```
$ grpcurl \
# This is also a live demo!
$ go install github.com/fullstorydev/grpcurl/cmd/grpcurl@latest && \
grpcurl \
-d '{"sentence": "I feel happy."}' \
demo.connectrpc.com:443 \
buf.connect.demo.eliza.v1.ElizaService/Say
Expand Down Expand Up @@ -151,7 +155,7 @@ configuring timeouts, connection pools, observability, and h2c.

* [connect-grpchealth-go]: gRPC-compatible health checks
* [connect-grpcreflect-go]: gRPC-compatible server reflection
* [connect-demo]: demonstration service, including bidi streaming
* [connect-demo]: demonstration service powering demo.connectrpc.com, including bidi streaming
* [connect-crosstest]: gRPC and gRPC-Web interoperability tests

## Status
Expand Down

0 comments on commit 03661b5

Please sign in to comment.