From 3a40c747e60f7b8f06994f881ce4fa109af54c4d Mon Sep 17 00:00:00 2001 From: Areek Zillur Date: Mon, 10 Nov 2014 16:26:39 -0500 Subject: [PATCH] [DOCS] add REST API and DESIGN doc links to readme Original commit: elastic/x-pack-elasticsearch@828d7370b0dce8a7e7c38fb9aebc503d376e3fb3 --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 24be2b3212e..05c56fc7c6c 100644 --- a/README.md +++ b/README.md @@ -3,20 +3,29 @@ elasticsearch-license Internal Elasticsearch Licensing Plugin -## License Tools +## License Tools [PRIVATE] License tools are a collection of command-line tools to generate key-pair and signed license(s). It also provides a tool to verify issued signed license(s) and generate effective license file from a collection of issued license files. see [License Tools Usage & Reference] (https://github.com/elasticsearch/elasticsearch-license/tree/es_integration/docs/private/license-tools.asciidoc) -## Licensing Consumer Interface +## Licensing Consumer Interface [PRIVATE] Licensing Consumer Interface defines how consumer plugins should enforce licensing on a feature in question using the license-plugin. see [Licensing Consumer Interface] (https://github.com/elasticsearch/elasticsearch-license/tree/es_integration/docs/private/license-consumer-interface.asciidoc) -## Licensing Plugin -TODO +## Licensing REST APIs [PUBLIC] +Licensing REST APIs enable users to: + + - register signed license(s) to their deployment provided by elasticsearch + - view current status of signed and one-time-trial licenses effective in their deployment + +see [Licensing REST APIs] (https://github.com/elasticsearch/elasticsearch-license/blob/es_integration/docs/public/license.asciidoc) + +## Licensing Plugin Design [PRIVATE] + +see [Licensing Plugin Design] (https://github.com/elasticsearch/elasticsearch-license/blob/es_integration/docs/private/license-plugin-design.asciidoc)