Skip to content

Commit 565f867

Browse files
authored
feat: use npm name cloudevents (#260)
BREAKING CHANGE: This changes the modules name from cloudevents-sdk to cloudevents * feat: use npm name cloudevents fixes #215 Signed-off-by: Grant Timmerman <timmerman+devrel@google.com>
1 parent 4b54b27 commit 565f867

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The CloudEvents SDK requires a current LTS version of Node.js. At the moment
2222
those are Node.js 10.x and Node.js 12.x. To install in your Node.js project:
2323

2424
```console
25-
npm install cloudevents-sdk
25+
npm install cloudevents
2626
```
2727

2828
### Receiving and Emitting Events
@@ -37,7 +37,7 @@ binary and structured events in either the 1.0 or 0.3 protocol formats.
3737
const {
3838
CloudEvent,
3939
Receiver
40-
} = require("cloudevents-sdk");
40+
} = require("cloudevents");
4141

4242
// Create a receiver to accept events over HTTP
4343
const receiver = new Receiver();
@@ -58,7 +58,7 @@ structured events, add `Protocol.HTTPStructured` as a parameter to
5858
`emitter.send()`.
5959

6060
```js
61-
const { CloudEvent, Emitter, Protocol, Version } = require("cloudevents-sdk");
61+
const { CloudEvent, Emitter, Protocol, Version } = require("cloudevents");
6262

6363
// With only an endpoint URL, this creates a v1 emitter
6464
const emitter = new Emitter({
@@ -101,7 +101,7 @@ All created `CloudEvent` objects are read-only. If you need to update a propert
101101
```js
102102
const {
103103
CloudEvent,
104-
} = require("cloudevents-sdk");
104+
} = require("cloudevents");
105105

106106
// Create a new CloudEvent
107107
const ce = new CloudEvent({...});

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "cloudevents-sdk",
2+
"name": "cloudevents",
33
"version": "2.0.2",
44
"description": "CloudEvents SDK for JavaScript",
55
"main": "dist/index.js",

0 commit comments

Comments
 (0)