From 5e15f8b82108f3ddb6df6dc862ff2e15182e6cb7 Mon Sep 17 00:00:00 2001 From: Carolyn Van Slyck Date: Mon, 6 May 2019 14:54:04 -0500 Subject: [PATCH] Clarify what duffle is intended for (#739) * Clarify what duffle is intended for Duffle is the reference implementation of the spec. Point people to some of the community tools if they want to build new bundles. * Incorporate review feedback * Link to the CNAB SDK section --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 56bea734..18ad32c0 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,15 @@ [![Waffle.io - Columns and their card count](https://badge.waffle.io/deislabs/duffle.svg?columns=In%20Progress,Needs%20Review,Done)](https://waffle.io/deislabs/duffle) -Duffle is a command line tool that allows you to install and manage CNAB bundles. To learn more about about CNAB and duffle, check out the [docs](docs/README.md). +Duffle is the reference implementation of the [CNAB specification][cnab]. It +provides a comprehensive mapping of _all_ features of the specification, serving +both as a tool to install and manage bundles, and author bundles at a low level. + +The community has created implementations of the CNAB spec with +[opinionated takes on authoring bundles][cnab-tools]. Some even use Duffle's +[libraries][cnab-sdk] to handle the CNAB implementation. If you want to make your own CNAB tooling, that is a great place to start! + +Learn more about about CNAB and Duffle, check out our [docs](docs/README.md). ## Getting Started @@ -104,3 +112,7 @@ Duffle is a command line tool that allows you to install and manage CNAB bundles ## Developing Duffle See the [Developer's Guide](docs/developing.md). + +[cnab]: https://cnab.io +[cnab-tools]: https://cnab.io/community-projects/#tools +[cnab-sdk]: https://cnab.io/community-projects/#sdk \ No newline at end of file