Skip to content

Commit

Permalink
chore: copy README to core
Browse files Browse the repository at this point in the history
  • Loading branch information
niuiic committed Apr 9, 2024
1 parent 6493491 commit 58ec024
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
33 changes: 33 additions & 0 deletions packages/core/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<br/>

<p align="center">
<a href="https://fx-flow.niuiic.com" target="_blank" rel="noopener noreferrer">
<img id="flow-logo" width="480" height="300" src="https://github.com/niuiic/fx-flow/blob/main/packages/doc/docs/public/logo.jpeg" alt="Logo">
</a>
</p>

<br/>

<p align="center">
<a href="https://npmjs.com/package/fx-flow"><img src="https://img.shields.io/npm/v/fx-flow.svg" alt="npm package"></a>
<a href="https://github.com/niuiic/fx-flow/tree/main/.github/workflows/test.yml"><img src="https://github.com/niuiic/fx-flow/actions/workflows/test.yml/badge.svg" alt="test status"></a>
<a href="https://github.com/niuiic/fx-flow/tree/main/.github/workflows/coverage.yml"><img src="https://github.com/niuiic/fx-flow/blob/coverage/badge-statements.svg" alt="test coverage"></a>
</p>

# Fx-Flow <img width="32" src="https://github.com/niuiic/fx-flow/blob/main/packages/doc/docs/public/flow.svg"/>

> Functional library for TypeScript/JavaScript
- Streaming programming
- Graceful error handling
- Asynchronous data flow management
- Lazy evaluation
- Complete typeScript support
- Zero runtime dependency
- Well tested

[Read the Docs to Learn More](https://fx-flow.niuiic.com).

## License

[MIT](LICENSE) License © 2023-PRESENT [niuiic](https://github.com/niuiic)
2 changes: 1 addition & 1 deletion packages/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "0.5.0",
"description": "A functional library for TypeScript/JavaScript",
"type": "module",
"files": ["dist", "../../README.md"],
"files": ["dist"],
"main": "./dist/cjs/index.js",
"module": "./dist/esm/index.js",
"types": "./dist/type/index.d.ts",
Expand Down

0 comments on commit 58ec024

Please sign in to comment.