serverscanning/capnproto-java-rpc
16
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

link to github pages documentation

Browse source
This commit is contained in:
David Renshaw 2014-06-14 11:38:15 -04:00
parent 01edadb4c6
commit 1e7c3e3140
1 changed files with 4 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -2,33 +2,10 @@
[![Build Status](https://travis-ci.org/dwrensha/capnproto-java.svg?branch=master)](https://travis-ci.org/dwrensha/capnproto-java)
This is an experimental pure Java implementation of [Cap'n Proto](http://capnproto.org).
It doesn't do much yet.
[Cap'n Proto](http://capnproto.org) is an extremely efficient protocol for sharing data
and capabilities.
## getting started
You will need [SBT](http://scala-sbt.org). We recommend [this version](https://github.com/paulp/sbt-extras).
To compile:
```
$ sbt compile
```
To read a message:
```
$ echo '(people = [(id = 123, name = "Alice", email = "alice@example.com", employment = (school = "MIT"))])' \
| capnp encode examples/src/main/schema/addressbook.capnp AddressBook \
| java -cp runtime/target/scala-2.11/classes:examples/target/scala-2.11/classes/ \
org.capnproto.examples.AddressbookMain read
```
To write a message:
```
$ java -cp runtime/target/scala-2.11/classes:examples/target/scala-2.11/classes/ \
org.capnproto.examples.AddressbookMain write \
| capnp decode examples/src/main/schema/addressbook.capnp AddressBook
```
To generate IntelliJ project files, do `sbt update gen-idea`.
capnproto-java is an early-state pure Java implmentation.
Read more [here](https://dwrensha.github.io/capnproto-java/index.html).