From 1e7c3e3140a294dee158a96b17f28c3b471f2e77 Mon Sep 17 00:00:00 2001 From: David Renshaw Date: Sat, 14 Jun 2014 11:38:15 -0400 Subject: [PATCH] link to github pages documentation --- README.md | 31 ++++--------------------------- 1 file changed, 4 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 75d3434..c7f38d9 100644 --- a/README.md +++ b/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) -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).