Skip to content

feat: use npm name cloudevents #260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 24, 2020
Merged

feat: use npm name cloudevents #260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
730b0e8
feat: use npm name cloudevents
grant Jul 23, 2020
7309f5e
Merge branch 'master' into grant_npm_cloudevents
grant Jul 23, 2020
664d0ba
fix: update package.json
grant Jul 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The CloudEvents SDK requires a current LTS version of Node.js. At the moment
those are Node.js 10.x and Node.js 12.x. To install in your Node.js project:

```console
npm install cloudevents-sdk
npm install cloudevents
```

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

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

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

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

// Create a new CloudEvent
const ce = new CloudEvent({...});
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "cloudevents-sdk",
"name": "cloudevents",
"version": "2.0.2",
"description": "CloudEvents SDK for JavaScript",
"main": "dist/index.js",
Expand Down