|
5 | 5 |  |
6 | 6 | [](https://www.npmjs.com/package/cloudevents-sdk) |
7 | 7 | [](https://snyk.io/test/github/cloudevents/sdk-javascript) |
8 | | -[](http://www.apache.org/licenses/LICENSE-2.0) |
9 | | - |
10 | 8 |
|
11 | 9 | The CloudEvents SDK for JavaScript. |
12 | 10 |
|
13 | | -This module will help you to: |
| 11 | +## Features |
14 | 12 |
|
15 | 13 | * Represent CloudEvents in memory |
16 | | -* Use [Event Formats](https://github.com/cloudevents/spec/blob/v1.0/spec.md#event-format) to serialize/deserialize CloudEvents |
17 | | -* Use [Protocol Bindings](https://github.com/cloudevents/spec/blob/v1.0/spec.md#protocol-binding) to send/receive CloudEvents |
18 | | - |
19 | | -_Note:_ Supported |
20 | | -[CloudEvents specification](https://github.com/cloudevents/spec): 0.3, 1.0 |
21 | | - |
22 | | -### A Note on Versioning |
23 | | - |
24 | | -The CloudEvents protocol version is distinct from this module's version number. |
25 | | -For example, this module may be versioned as v2.0.0 but support the v0.3 and v1.0 |
26 | | -versions of the CloudEvent specification. |
27 | | - |
28 | | -## Usage |
| 14 | +* Serialize and deserialize CloudEvents in different [event formats](https://github.com/cloudevents/spec/blob/v1.0/spec.md#event-format). |
| 15 | +* Send and recieve CloudEvents with via different [protocol bindings](https://github.com/cloudevents/spec/blob/v1.0/spec.md#protocol-binding). |
29 | 16 |
|
30 | | -**See the full working example: [here](./examples/express-ex).** |
| 17 | +_Note:_ Supports CloudEvent versions 0.3, 1.0 |
31 | 18 |
|
32 | | -### Installation |
| 19 | +## Installation |
33 | 20 |
|
34 | 21 | The CloudEvents SDK requires a current LTS version of Node.js. At the moment |
35 | 22 | those are Node.js 10.x and Node.js 12.x. To install in your Node.js project: |
36 | 23 |
|
37 | 24 | ```console |
38 | | -npm install --save cloudevents-sdk |
| 25 | +npm install cloudevents-sdk |
39 | 26 | ``` |
40 | 27 |
|
41 | 28 | ### Receiving and Emitting Events |
|
0 commit comments