From ec8cf9fb26efc4a59359e78048ac01a49ac839f9 Mon Sep 17 00:00:00 2001 From: Jimmy Zelinskie Date: Wed, 24 Feb 2016 16:24:44 -0500 Subject: [PATCH] README: add documentation with links --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index e028100b..46741b1d 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,13 @@ $ ./$GOBIN/clair -config=config.yaml ![Simple Clair Diagram](img/simple_diagram.png) +### Documentation + +Documentation can be found in a README.md file located in the directory of the component. + +- [Notifier](https://github.com/coreos/clair/blob/master/notifier/README.md) +- [v1 API](https://github.com/coreos/clair/blob/master/api/v1/README.md) + ### Vulnerability Analysis There are two major ways to perform analysis of programs: [Static Analysis] and [Dynamic Analysis].