Skip to content

Commit 6a8495b

Browse files
docs(README.md): update.
1 parent b0e37fd commit 6a8495b

File tree

1 file changed

+34
-12
lines changed

1 file changed

+34
-12
lines changed

README.md

Lines changed: 34 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,68 @@
11
<a href="https://www.typescriptlang.org/">
22
<img
3-
src="https://raw.githubusercontent.com/typescript-package/core/refs/heads/main/ts-package-barcode-logo-512.png"
4-
width="20%"
3+
src="https://avatars.githubusercontent.com/u/189666396?s=150&u=9d55b1eb4ce258974ead76bf07ccf49ef0eb0ea7&v=4"
54
title="@typescript-package/core"
65
/>
76
</a>
87

98
## typescript-package/core
109

11-
Core package.
12-
1310
<!-- npm badge -->
1411
[![npm version][typescript-package-npm-badge-svg]][typescript-package-npm-badge]
1512
[![GitHub issues][typescript-package-badge-issues]][typescript-package-issues]
1613
[![GitHub license][typescript-package-badge-license]][typescript-package-license]
1714

15+
A TypeScript library with features used across other `typescript-package` libraries.
16+
1817
<br>
1918

2019
## Table of contents
2120

22-
* [Installation](#installation)
23-
* [Api](#api)
24-
* [Git](#git)
25-
* [Commit](#commit)
26-
* [Versioning](#versioning)
27-
* [License](#license)
21+
- [Installation](#installation)
22+
- [Api](#api)
23+
- [Contributing](#contributing)
24+
- [Support](#support)
25+
- [Code of Conduct](#code-of-conduct)
26+
- [Git](#git)
27+
- [Commit](#commit)
28+
- [Versioning](#versioning)
29+
- [License](#license)
2830

2931
## Installation
3032

3133
```bash
32-
npm install @typescript-package/core
34+
npm install @typescript-package/core --save-peer
3335
```
3436

3537
## Api
3638

3739
```typescript
3840
import {
3941
resultCallback,
40-
typeOf
42+
typeOf,
43+
Value
4144
} from '@typescript-package/core';
4245
```
4346

47+
## Contributing
48+
49+
Your contributions are valued! If you'd like to contribute, please feel free to submit a pull request. Help is always appreciated.
50+
51+
## Support
52+
53+
If you find this package useful and would like to support its and general development, you can contribute through one of the following payment methods. Your support helps maintain the packages and continue adding new.
54+
55+
Support via:
56+
57+
- [Stripe](https://donate.stripe.com/dR614hfDZcJE3wAcMM)
58+
- [Revolut](https://checkout.revolut.com/pay/048b10a3-0e10-42c8-a917-e3e9cb4c8e29)
59+
60+
Thanks for your support!
61+
62+
## Code of Conduct
63+
64+
By participating in this project, you agree to follow **[Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/)**.
65+
4466
## GIT
4567

4668
### Commit

0 commit comments

Comments
 (0)