Skip to content

Commit

Permalink
Update java version to 1.8 in pom.xml, README fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
masomel committed Oct 12, 2018
1 parent 7800bb6 commit 264439a
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 23 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions 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).

Expand All @@ -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)
12 changes: 6 additions & 6 deletions 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.
Expand All @@ -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
Expand Down Expand Up @@ -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.

Expand All @@ -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)
12 changes: 6 additions & 6 deletions 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.
Expand All @@ -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
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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)
4 changes: 2 additions & 2 deletions pom.xml
Expand Up @@ -52,8 +52,8 @@
<artifactId>maven-compiler-plugin</artifactId>
<version>3.5.1</version>
<configuration>
<source>1.7</source>
<target>1.7</target>
<source>1.8</source>
<target>1.8</target>
<showWarnings>true</showWarnings>
<showDeprecation>true</showDeprecation>
<compilerArgs>
Expand Down
8 changes: 4 additions & 4 deletions 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/).

Expand All @@ -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/)

0 comments on commit 264439a

Please sign in to comment.