Skip to content

Commit a8b5894

Browse files
committed
docs(readme): update
1 parent 0df947f commit a8b5894

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,19 @@
33
![Node CI](https://github.com/unadlib/data-transport/workflows/Node%20CI/badge.svg)
44
[![npm version](https://badge.fury.io/js/data-transport.svg)](http://badge.fury.io/js/data-transport)
55

6-
A simple and responsible transport
6+
A simple and responsive transport
77

88
## Motivation
99

10-
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.
10+
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.
1111

1212
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.
1313

14+
You can use `data-transport` to communicate between different front-end communication APIs.
15+
1416
## Support Transport
1517

16-
`data-transport` is a generic and responsible communication transporter
18+
`data-transport` is a generic and responsive communication transporter
1719

1820
- iframe
1921
- Broadcast
@@ -90,5 +92,8 @@ expect(await internal.emit('hello', 42).toEqual({ text: 'hello 42' });
9092
## Example
9193
9294
- [More examples](./examples)
93-
9495
- [Online with Broadcast](https://codesandbox.io/s/data-transport-example-lkg8k)
96+
97+
## License
98+
99+
[MIT](./LICENSE)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "data-transport",
33
"version": "4.5.1",
4-
"description": "A simple and responsible transport",
4+
"description": "A simple and responsive transport",
55
"main": "lib/index.js",
66
"unpkg": "dist/index.umd.js",
77
"types": "dist/index.d.ts",

0 commit comments

Comments
 (0)