Skip to content

Commit

Permalink
docs(readme): update
Browse files Browse the repository at this point in the history
  • Loading branch information
unadlib committed Jan 20, 2025
1 parent 0df947f commit a8b5894
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,19 @@
![Node CI](https://github.com/unadlib/data-transport/workflows/Node%20CI/badge.svg)
[![npm version](https://badge.fury.io/js/data-transport.svg)](http://badge.fury.io/js/data-transport)

A simple and responsible transport
A simple and responsive transport

## Motivation

Many front-end communication APIs based on JavaScript are almost one-way communication, and their communication interface are often different. In terms of communication interaction protocols, we need an universal and responsive communication library that will help us communicate in any scenario very simply and easily.
Many front-end communication APIs based on JavaScript are almost one-way communication, and their communication interface are often different. In terms of communication interaction protocols, we need an universal and responsive communication library that will help us communicate in any scenario very simply and easily.

And It is also very easy to mock to be used for testing, and it is also easy to design an common interface that is compatible with multiple communication APIs.

You can use `data-transport` to communicate between different front-end communication APIs.

## Support Transport

`data-transport` is a generic and responsible communication transporter
`data-transport` is a generic and responsive communication transporter

- iframe
- Broadcast
Expand Down Expand Up @@ -90,5 +92,8 @@ expect(await internal.emit('hello', 42).toEqual({ text: 'hello 42' });
## Example
- [More examples](./examples)
- [Online with Broadcast](https://codesandbox.io/s/data-transport-example-lkg8k)
## License
[MIT](./LICENSE)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "data-transport",
"version": "4.5.1",
"description": "A simple and responsible transport",
"description": "A simple and responsive transport",
"main": "lib/index.js",
"unpkg": "dist/index.umd.js",
"types": "dist/index.d.ts",
Expand Down

0 comments on commit a8b5894

Please sign in to comment.