From 1eddb696eea94f2b637ecf078f7c96d41bbdddf4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabio=20Jos=C3=A9?= Date: Fri, 9 Nov 2018 13:58:07 -0200 Subject: [PATCH] Documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabio José --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index 5ba39f8..27c6f75 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ # sdk-javascript Javascript SDK for CloudEvents + +# Repository Structure + +```text +├── index.js +├── lib +│   ├── cloudevent.js +│   ├── jsonformatter.js +│   ├── spec_0_1.js +│   └── spec_0_2.js +├── LICENSE +├── package.json +├── README.md +└── test + ├── cloudevent_spec_0_1.js + └── cloudevent_spec_0_2.js + +``` + +* `index.js`: exports the Cloudevent class + +* `lib/cloudevent.js`: implementation of Cloudevent class + +* `lib/jsonformatter.js`: implementation for JSON Format + +* `lib/spec_0_1.js`: implementation for spec version 0.1 + +* `lib/spec_0_2.js`: implementation for spec version 0.2 +