diff --git a/README.md b/README.md index 5fea1ca..3f85840 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ for the client-server messages. ## Disclaimer Please keep in mind that this CONIKS Java implementation is under active development. The repository may contain experimental features that aren't fully tested. We recommend using a [tagged release](https://github.com/coniks-sys/coniks-java/releases). -##Documentation +## Documentation [Read the package's Java API (javadoc)](https://coniks-sys.github.io/coniks-java/) ## Current Core Developers diff --git a/coniks_common/README.md b/coniks_common/README.md index eaa616c..dbf740d 100644 --- a/coniks_common/README.md +++ b/coniks_common/README.md @@ -1,11 +1,11 @@ -#CONIKS Common +# CONIKS Common http://coniks.org -##Introduction +## Introduction These are the files common to the basic implementation of a CONIKS server and the simple CONIKS test client. -##Using the Common Files +## Using the Common Files ### Protobufs CONIKS uses Google Protobufs to define the message format for all communication between the test client and the basic server. Since the Protos Java files are generated by compiling the .proto files, you should never directly edit them! If you wish to modify the format of a specific message, do so in the appropriate .proto source file and recompile it (see [Using the Protobufs](https://github.com/coniks-sys/coniks-java/tree/master/protos#using-the-protobufs) for details). @@ -25,5 +25,5 @@ These instructions will install the ``coniks_common`` Maven artifact. ## Disclaimer Please keep in mind that this CONIKS Java implementation is under active development. The repository may contain experimental features that aren't fully tested. We recommend using a [tagged release](https://github.com/coniks-sys/coniks-java/releases). -##Documentation +## Documentation [Read the common files' Java API (javadoc)](https://coniks-sys.github.io/coniks-java/org/coniks/coniks_common/package-summary.html) diff --git a/coniks_server/README.md b/coniks_server/README.md index 909f35a..36abbe5 100644 --- a/coniks_server/README.md +++ b/coniks_server/README.md @@ -1,11 +1,11 @@ -#CONIKS Server +# CONIKS Server http://coniks.org -##Introduction +## Introduction This is a basic reference implementation of a server for the CONIKS key management system. It currently supports new key registrations, key lookups, changes to key data and user policies (**new features**) and can generate consistency proofs and signed directory summaries. It is designed to communicate with the [CONIKS test client](https://github.com/coniks-sys/coniks-java/tree/master/coniks_test_client). -##Building the Server - With Maven +## Building the Server - With Maven The coniks_server build is managed using Maven. (Instructions for building without Maven coming soon) 1) Install Apache Maven, if you don't have it. Visit the [Maven downloads page](https://maven.apache.org/download.cgi) for details. @@ -23,7 +23,7 @@ The build configuration for coniks_server assembles all dependencies, and includes them in the generated .jar file, so you can run the server only using the coniks_server .jar file. -##Using the Server +## Using the Server The CONIKS server has two operating modes: Test Mode and Full Operation. Running the server in test mode allows you to still test all CONIKS @@ -72,7 +72,7 @@ Defaults are already set, but you may change the following variables: ```CONIKS_SERVERCONFIG``` if you're using a different config file ```CONIKS_SERVERLOGS``` to store the server logs somewhere other than a *logs* directory -###Running +### Running We provide a run script for the CONIKS server *coniks_server.sh*, which allows you to run the server in full operation mode and test mode. @@ -88,5 +88,5 @@ Analogously to test and stop the server, and remove the logs. ## Disclaimer Please keep in mind that this CONIKS Java implementation is under active development. The repository may contain experimental features that aren't fully tested. We recommend using a [tagged release](https://github.com/coniks-sys/coniks-java/releases). -##Documentation +## Documentation [Read the server's Java API (javadoc)](https://coniks-sys.github.io/coniks-java/org/coniks/coniks_server/package-summary.html) diff --git a/coniks_test_client/README.md b/coniks_test_client/README.md index 49bf051..1e8728f 100644 --- a/coniks_test_client/README.md +++ b/coniks_test_client/README.md @@ -1,11 +1,11 @@ -#CONIKS Test Client +# CONIKS Test Client http://coniks.org -##Introduction +## Introduction This is a simple test client for the CONIKS key management system. It supports new key registrations, key lookups, key changes (**new feature**), and user policy changes (e.g. key change policy) (**new feature**). It is designed to communicate with the basic implementation of a [CONIKS server](https://github.com/coniks-sys/coniks-java/tree/master/coniks_server). -##Building the Test Client - With Maven +## Building the Test Client - With Maven The coniks_test_client build is managed using Maven. (Instructions for building without Maven coming soon) 1) Install Apache Maven, if you don't have it. Visit the [Maven downloads page](https://maven.apache.org/download.cgi) for details. @@ -21,7 +21,7 @@ The build configuration for coniks_test_client assembles all dependencies, and includes them in the generated .jar file, so you can run the server only using the coniks_test_client .jar file. -##Using the Test Client +## Using the Test Client The CONIKS test client has two operating modes: Test Mode and Full Operation. Running the client in test mode allows you to still test all CONIKS @@ -53,7 +53,7 @@ Defaults are already set, but you may change the following variables: ```CONIKS_CLIENTCONFIG``` if you're using a different config file ```CONIKS_CLIENTLOGS``` to store the client logs somewhere other than a *logs* directory -###Running +### Running We provide a run script for the CONIKS test client *coniks_test_client.sh*, which allows you to run the test client in full operation mode and test mode. @@ -87,5 +87,5 @@ Some examples: ## Disclaimer Please keep in mind that this CONIKS Java implementation is under active development. The repository may contain experimental features that aren't fully tested. We recommend using a [tagged release](https://github.com/coniks-sys/coniks-java/releases). -##Documentation +## Documentation [Read the test client's Java API (javadoc)](https://coniks-sys.github.io/coniks-java/org/coniks/coniks_test_client/package-summary.html) diff --git a/pom.xml b/pom.xml index 2053ff0..0f7bdf5 100644 --- a/pom.xml +++ b/pom.xml @@ -52,8 +52,8 @@ maven-compiler-plugin 3.5.1 - 1.7 - 1.7 + 1.8 + 1.8 true true diff --git a/protos/README.md b/protos/README.md index 0fe2e44..1ea6286 100644 --- a/protos/README.md +++ b/protos/README.md @@ -1,11 +1,11 @@ -#CONIKS Protos +# CONIKS Protos http://coniks.org -##Introduction +## Introduction These are protobuf source files that define the message format for all communication between the CONIKS test client and the basic server. They are based on [Google Protobufs](https://github.com/google/protobuf) (proto2) and require you to have the protocol buffer compiler protoc installed. -##Using the Protobufs +## Using the Protobufs ### Editing Extensive documentation on developing protocol buffers can be found [here](https://developers.google.com/protocol-buffers/). @@ -30,5 +30,5 @@ This command will automatically place the generated Java code in the appropriate ## Disclaimer Please keep in mind that this CONIKS Java implementation is under active development. The repository may contain experimental features that aren't fully tested. We recommend using a [tagged release](https://github.com/coniks-sys/coniks-java/releases). -##Documentation +## Documentation [Read the official Google Protobuf documentation](https://developers.google.com/protocol-buffers/)