From d7955d6b7afd375c760cddcab94b320b46a68687 Mon Sep 17 00:00:00 2001 From: David Lawrence Date: Sun, 21 Jun 2015 14:54:27 -0700 Subject: [PATCH] adding a little more to notary server readme --- cmd/notary-server/README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/cmd/notary-server/README.md b/cmd/notary-server/README.md index 4f4ceff375..a4f5370601 100644 --- a/cmd/notary-server/README.md +++ b/cmd/notary-server/README.md @@ -1,9 +1,15 @@ # Notary Server -Notary Server manages TUF data. It may be configured to use either JWT -or HTTP Basic Auth for authentication. Currently it only supports MySQL -for store of the TUF data, we intend to expand this to other storage -options. +Notary Server manages TUF data over an HTTP API compatible with the +[notary client](../notary/). The API is defined as part of the [distribution +specification](https://github.com/docker/distribution/blob/master/docs/spec/api.md) +as it is intended to be used side by side with a docker registry and +the URL paths are designed to be compatible with the existing registry +URL structure. + +It may be configured to use either JWT or HTTP Basic Auth for authentication. +Currently it only supports MySQLfor store of the TUF data, we intend to +expand this to other storage options. ## Setup for Development