Commit 81d0a124 authored by David Stainton's avatar David Stainton

Fix readme, add some words about testing

parent cca2c471
Pipeline #977 passed with stage
in 4 minutes and 49 seconds
.. image:: https://travis-ci.org/katzenpost/client.svg?branch=master
:target: https://travis-ci.org/katzenpost/client
......@@ -10,6 +9,26 @@
Katzenpost Mix Network Client Library
=====================================
This client library is general purpose in the sense that it can be used to
build arbitrarily complex messaging systems using Katzenpost. However note that
right now it only supports strict SURB based query response protocols to
interactive mix network services. These services can be written in any langauge
and plugged into the Providers. Furthermore this client does not yet perform
any retransmissions if a packet gets dropped by the mix network.
travis tests
------------
Travis tests may sometimes fail if they take too long.
gitlab CI tests
---------------
Our gitlab tests are located here:
https://gitlab.techcultivation.org/katzenpost/client/-/jobs
optional docker tests
---------------------
......@@ -22,10 +41,7 @@ https://github.com/katzenpost/docker
A couple of minutes after startup run the tests like this:
::
GORACE=history_size=7 go test -v -tags=docker_test -race -run TestDockerClientBlockingSendReceive
GORACE=history_size=7 go test -v -tags=docker_test -race -run TestDockerClientBlockingSendReceiveWithDecoyTraffic
GORACE=history_size=7 go test -v -tags=docker_test -race -run TestDockerClientAsyncSendReceive
GORACE=history_size=7 go test -v -tags=docker_test -race -run TestDockerClientAsyncSendReceiveWithDecoyTraffic
GORACE=history_size=7 go test -race -v -run Docker
license
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment