link to github pages documentation
This commit is contained in:
parent
01edadb4c6
commit
1e7c3e3140
1 changed files with 4 additions and 27 deletions
31
README.md
31
README.md
|
@ -2,33 +2,10 @@
|
||||||
|
|
||||||
[![Build Status](https://travis-ci.org/dwrensha/capnproto-java.svg?branch=master)](https://travis-ci.org/dwrensha/capnproto-java)
|
[![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
|
capnproto-java is an early-state pure Java implmentation.
|
||||||
|
|
||||||
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`.
|
|
||||||
|
|
||||||
|
Read more [here](https://dwrensha.github.io/capnproto-java/index.html).
|
||||||
|
|
Loading…
Reference in a new issue