From 29f2ce4d076b2f9da8d7910706e04e5ce4d9dd73 Mon Sep 17 00:00:00 2001 From: Arthur Fiorette Date: Thu, 9 Feb 2023 00:41:58 -0300 Subject: [PATCH] docs: updated readme --- README.md | 73 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 43 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 9d97592..4cd7671 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,66 @@

- Using this package? Please consider donating to support my open source work ❤️ + Using this package? Please consider donating to support my open source work ❤️
- Help axios-cache-interceptor grow! Star and share this amazing repo with your friends and co-workers! + Help axios-cache-interceptor grow! Star and share this amazing repository with your friends and co-workers!


- -[![License](https://img.shields.io/github/license/arthurfiorette/axios-cache-interceptor?logo=githu&label=License)](https://github.com/arthurfiorette/axios-cache-interceptor/blob/main/LICENSE) -[![Codecov](https://img.shields.io/codecov/c/github/arthurfiorette/axios-cache-interceptor?token=ML0KGCU0VM)](https://codecov.io/gh/arthurfiorette/axios-cache-interceptor) -[![Downloads](https://img.shields.io/npm/dm/axios-cache-interceptor?style=flat)](https://www.npmjs.com/package/axios-cache-interceptor) -[![Bundlephobia](https://img.shields.io/bundlephobia/minzip/axios-cache-interceptor/latest?style=flat)](https://bundlephobia.com/package/axios-cache-interceptor@latest) -[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Farthurfiorette%2Faxios-cache-interceptor.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Farthurfiorette%2Faxios-cache-interceptor?ref=badge_shield) -[![Last commit](https://img.shields.io/github/last-commit/arthurfiorette/axios-cache-interceptor)](https://github.com/arthurfiorette/axios-cache-interceptor/commits) +

+ + Axios Cache Interceptor logo + +


-

- ⚡Axios Cache Interceptor is a small and efficient cache interceptor for axios. -
-
-

+

+ GitHub + Codecov + Downloads + Bundlephobia + FOSSA Status + Last commit +

+
+
+ +# Axios Cache Interceptor + +> Cache interceptor for axios made with developers and performance in mind. + +
+ +- ⚡ Faster +- 📦 Handy builds +- 🔩 Hassle free +- 🛠️ Rich Features +- 🌐 No network waste! +- 🔑 TypeScript! + +Axios Cache Interceptor is, as it name says, a interceptor for axios to handle caching. It +was created to help developers call axios multiple times without having to worry about +overloading the network or coding himself a simple and buggy cache system. + +
+ +[Read the docs to **Learn More**.](https://axios-cache-interceptor.js.org) + +

```ts import Axios from 'axios'; import { setupCache } from 'axios-cache-interceptor'; -// same object, but with updated typings. +// Same object, new types. const axios = setupCache(Axios); -const req1 = axios.get('https://api.example.com/'); -const req2 = axios.get('https://api.example.com/'); +const req1 = axios.get('https://arthur.place/'); +const req2 = axios.get('https://arthur.place/'); const [res1, res2] = await Promise.all([req1, req2]); @@ -44,12 +70,6 @@ res2.cached; // true
-

- Documentation at axios-cache-interceptor.js.org 🎉🎉 -

- -
- ## License Licensed under the **MIT**. See [`LICENSE`](LICENSE) for more informations. @@ -57,10 +77,3 @@ Licensed under the **MIT**. See [`LICENSE`](LICENSE) for more informations. [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Farthurfiorette%2Faxios-cache-interceptor.svg?type=small)](https://app.fossa.com/projects/git%2Bgithub.com%2Farthurfiorette%2Faxios-cache-interceptor?ref=badge_small)
- -## Contact - -See my contact information on my [github profile](https://github.com/arthurfiorette) or -open a new issue. - -