Documentation

This commit is contained in:
Fabio José 2018-11-09 13:58:07 -02:00
parent 4a97553dfb
commit 2487db05a9
1 changed files with 29 additions and 0 deletions

View File

@ -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