Skip to content

Commit

Permalink
Update README.md (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
MagicCube authored and leohxj committed Aug 1, 2019
1 parent 35c3caf commit c9f00d3
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ Yab is a high-level HTTP client based on Fetch API and `koa-like` middlewares.
## Features

- **Middleware**: [koa](https://koajs.com/)-like middleware.
- **Fetch**: base on browser [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch) API.
- **Fetch**: based on browser [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch) API.
- **TypeScript**: Everything in Typescript.

## Browser Support

This library can only be used in [modern browser environment](https://caniuse.com/#search=fetch). [Polyfill](https://github.com/github/fetch) may be needed.
This library can only be used in [modern browser environments](https://caniuse.com/#search=fetch). [Polyfill](https://github.com/github/fetch) may be needed.

## Install

Expand Down Expand Up @@ -68,16 +68,16 @@ request.get("https://example.com");

## Documents

See full documents, please read [Yab-fetch](./packages/yab-fetch/README.md).
Please refer to [Yab-fetch](./packages/yab-fetch/README.md).

## Packages

This repository is a monorepo that we manage using Lerna. That means that we actually publish several packages to npm from the same codebase, including:
This repository is a mono-repo that we manage using Lerna. This means we actually publish several packages to npm from the same codebase, including:

| Package | Version | Description |
| -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| [`yab-fetch`](/packages/yab-fetch) | [![npm](https://img.shields.io/npm/v/yab-fetch.svg?style=flat-square)](https://www.npmjs.com/package/yab-fetch) | The fetch library. |
| [`yab-fetch-cache`](/packages/yab-fetch-cache) | [![npm](https://img.shields.io/npm/v/yab-fetch-cache.svg?style=flat-square)](https://www.npmjs.com/package/yab-fetch-cache) | A yab middleware, focus on cache response using IndexDB. |
| [`yab-fetch-cache`](/packages/yab-fetch-cache) | [![npm](https://img.shields.io/npm/v/yab-fetch-cache.svg?style=flat-square)](https://www.npmjs.com/package/yab-fetch-cache) | A yab middleware, focuses on caching response using IndexDB. |
| [`yab-fetch-logger`](/packages/yab-fetch-logger) | [![npm](https://img.shields.io/npm/v/yab-fetch-logger.svg?style=flat-square)](https://www.npmjs.com/package/yab-fetch-logger) | A yab middleware, logger request/response of fetch action |

## Changelog
Expand All @@ -86,7 +86,7 @@ Detailed changes for each release are documented in [CHANGELOG.md](./CHANGELOG.m

## Contributors

Thanks goes to the wonderful people.
Thanks go to the wonderful people.

## License

Expand Down

0 comments on commit c9f00d3

Please # to comment.