Skip to content

Commit ec05dee

Browse files
authored
update package name and docs (#2)
1 parent c7a72f7 commit ec05dee

File tree

4 files changed

+24
-24
lines changed

4 files changed

+24
-24
lines changed

LICENSE

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
The MIT License (MIT)
22

33
Copyright (c) 2015 Matt Andrews
4+
Copyright (c) 2022 Svix, Inc.
45

56
Permission is hereby granted, free of charge, to any person obtaining a copy
67
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,34 @@
1-
isomorphic-fetch [![Build Status](https://travis-ci.org/matthew-andrews/isomorphic-fetch.svg?branch=master)](https://travis-ci.org/matthew-andrews/isomorphic-fetch)
2-
================
1+
<h1 align="center">
2+
<a href="https://www.svix.com">
3+
<img width="120" src="https://avatars.githubusercontent.com/u/80175132?s=200&v=4" />
4+
<p align="center">Svix - Webhooks as a service</p>
5+
</a>
6+
</h1>
37

4-
Fetch for node and Browserify. Built on top of [GitHub's WHATWG Fetch polyfill](https://github.com/github/fetch).
8+
svix-fetch is a fork of Matthew Andrew's wonderful WHATWG Fetch polyfill for node and bowserfy: [isomorphic-fetch](https://github.com/matthew-andrews/isomorphic-fetch).
59

6-
## Warnings
10+
The main purpose of this fork is to enable keepalives when running in a node context.
711

8-
- This adds `fetch` as a global so that its API is consistent between client and server.
9-
10-
For [ease-of-maintenance and backward-compatibility reasons][why polyfill], this library will always be a polyfill. As a "safe" alternative, which does not modify the global, consider [fetch-ponyfill][].
11-
12-
[why polyfill]: https://github.com/matthew-andrews/isomorphic-fetch/issues/31#issuecomment-149668361
13-
[fetch-ponyfill]: https://github.com/qubyte/fetch-ponyfill
14-
15-
## Why Use Isomorphic Fetch
16-
17-
The Fetch API is currently [not implemented consistently](http://caniuse.com/#search=fetch) across browsers. This module will enable you to use `fetch` in your Node code in a cross-browser compliant fashion. The Fetch API is part of the Web platform API defined by the standards bodies WHATWG and W3C.
12+
Unless you have a specific need for this functionality we recommend using [isomorphic-fetch](https://github.com/matthew-andrews/isomorphic-fetch).
1813

1914
## Installation
2015

2116
### NPM
2217

2318
```sh
24-
npm install --save isomorphic-fetch
19+
npm install --save svix-fetch
2520
```
2621

2722
### Bower
2823

2924
```sh
30-
bower install --save isomorphic-fetch
25+
bower install --save svix-fetch
3126
```
3227

3328
## Usage
3429

3530
```js
36-
require('isomorphic-fetch');
31+
require('svix-fetch');
3732

3833
fetch('//offline-news-api.herokuapp.com/stories')
3934
.then(function(response) {
@@ -49,9 +44,10 @@ fetch('//offline-news-api.herokuapp.com/stories')
4944

5045
## License
5146

52-
All open source code released by FT Labs is licenced under the MIT licence. Based on [the fine work by](https://github.com/github/fetch/pull/31) **[jxck](https://github.com/Jxck)**.
47+
This code is licenced under the MIT licence. Based on [isomorphic-fetch](https://github.com/matthew-andrews/isomorphic-fetch) by **[matthew-andrews](https://github.com/matthew-andrews)**.
5348

5449
## Alternatives
5550

51+
- [isomorphic-fetch](https://github.com/matthew-andrews/isomorphic-fetch).
5652
- [cross-fetch](https://github.com/lquixada/cross-fetch#why-not-isomorphic-fetch)
5753
- Using [node-fetch](https://github.com/node-fetch/node-fetch) and the [Fetch polyfill](https://github.com/github/fetch) directly (or from [polyfill.io](https://polyfill.io), or relying on [the browser's implementation of the Fetch API](https://caniuse.com/fetch)).

bower.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "isomorphic-fetch",
2+
"name": "svix-fetch",
33
"main": ["fetch-bower.js"],
44
"dependencies": {
55
"fetch": "github/fetch#^3.4.1"

package.json

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "isomorphic-fetch",
2+
"name": "svix-fetch",
33
"version": "3.0.0",
4-
"description": "Isomorphic WHATWG Fetch API, for Node & Browserify",
4+
"description": "An isomorphic WHATWG Fetch API, for Node & Browserify with keepalives",
55
"browser": "fetch-npm-browserify.js",
66
"main": "fetch-npm-node.js",
77
"scripts": {
@@ -10,14 +10,17 @@
1010
},
1111
"repository": {
1212
"type": "git",
13-
"url": "https://github.com/matthew-andrews/isomorphic-fetch.git"
13+
"url": "https://github.com/svix/svix-fetch.git"
1414
},
1515
"author": "Matt Andrews <matt@mattandre.ws>",
16+
"contributors": [
17+
"Svix Inc. <support@svix.com>"
18+
],
1619
"license": "MIT",
1720
"bugs": {
18-
"url": "https://github.com/matthew-andrews/isomorphic-fetch/issues"
21+
"url": "https://github.com/svix/svix-fetch/issues"
1922
},
20-
"homepage": "https://github.com/matthew-andrews/isomorphic-fetch/issues",
23+
"homepage": "https://github.com/svix/svix-fetch/issues",
2124
"dependencies": {
2225
"node-fetch": "^2.6.1",
2326
"whatwg-fetch": "^3.4.1"

0 commit comments

Comments
 (0)