Skip to content

Commit 1b9b3af

Browse files
authored
Update README.md (cloudevents#205)
Signed-off-by: Grant Timmerman <[email protected]>
1 parent fba3294 commit 1b9b3af

File tree

1 file changed

+6
-19
lines changed

1 file changed

+6
-19
lines changed

README.md

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,24 @@
55
![Node.js CI](https://github.com/cloudevents/sdk-javascript/workflows/Node.js%20CI/badge.svg)
66
[![npm version](https://img.shields.io/npm/v/cloudevents-sdk.svg)](https://www.npmjs.com/package/cloudevents-sdk)
77
[![vulnerabilities](https://snyk.io/test/github/cloudevents/sdk-javascript/badge.svg)](https://snyk.io/test/github/cloudevents/sdk-javascript)
8-
[![licence](https://img.shields.io/github/license/cloudevents/sdk-javascript)](http://www.apache.org/licenses/LICENSE-2.0)
9-
108

119
The CloudEvents SDK for JavaScript.
1210

13-
This module will help you to:
11+
## Features
1412

1513
* 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).
2916

30-
**See the full working example: [here](./examples/express-ex).**
17+
_Note:_ Supports CloudEvent versions 0.3, 1.0
3118

32-
### Installation
19+
## Installation
3320

3421
The CloudEvents SDK requires a current LTS version of Node.js. At the moment
3522
those are Node.js 10.x and Node.js 12.x. To install in your Node.js project:
3623

3724
```console
38-
npm install --save cloudevents-sdk
25+
npm install cloudevents-sdk
3926
```
4027

4128
### Receiving and Emitting Events

0 commit comments

Comments
 (0)