Skip to content

Commit

Permalink
Remove instructions (for now)
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesplease authored Jun 10, 2020
1 parent fcaef5e commit 40a0331
Showing 1 changed file with 1 addition and 38 deletions.
39 changes: 1 addition & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,7 @@
# bestfetch

[![Travis build status](http://img.shields.io/travis/jamesplease/bestfetch.svg?style=flat)](https://travis-ci.org/jamesplease/bestfetch)
[![Test Coverage](https://coveralls.io/repos/github/jamesplease/bestfetch/badge.svg?branch=master)](https://coveralls.io/github/jamesplease/bestfetch?branch=master)
[![gzip size](http://img.badgesize.io/https://unpkg.com/bestfetch/lib/index.js?compression=gzip)](https://unpkg.com/bestfetch/lib/index.js)
> 🚨 WORK IN PROGRESS 🚨
> 🚨This project, `bestfetch` is a WIP improvement upon `fetch-dedupe`! `bestfetch` is not yet ready for use. 🚨
> *(as of April 2020)*
A [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)-like HTTP library that
implements request deduplication and response caching.

## Motivation

Making a single HTTP request is not difficult to do in JavaScript. However, complex web applications often make many
requests as the user navigates through the app.

Features such as request deduplication and response caching can often save the developer of apps like these from headache and
bugs.

`bestfetch` is a library with a familiar, fetch-like API, and it includes request deduplication and response caching. Plus,
it's a delight to use.

## Installation

Install using [npm](https://www.npmjs.com):

```
npm install bestfetch
```

or [yarn](https://yarnpkg.com/):

```
yarn add bestfetch
```

## Documentation

View the documentation at [https://jamesplease.github.io/bestfetch/](https://jamesplease.github.io/bestfetch/).

## Acknowledgements

[Apollo](https://www.apollographql.com/) inspired me to write this library.

0 comments on commit 40a0331

Please sign in to comment.