@deveox/humanize - npm Package Compare versions

Comparing version 0.1.40 to 0.1.41

CHANGELOG.md

@@ -0,1 +1,9 @@
+### [0.1.41](https://github.com/deveox/humanize/compare/v0.1.40...v0.1.41) (2022-08-05)
+
+
+### Documentation
+
+* **Readme:** update readme ([a36770c](https://github.com/deveox/humanize/commit/a36770c821acb8c54c8abfac293339ad60eb7db6))
+
+
 ### [0.1.40](https://github.com/deveox/humanize/compare/v0.1.39...v0.1.40) (2022-08-05)
@@ -2,0 +10,0 @@

package.json

 {
   "name": "@deveox/humanize",
-  "version": "0.1.40",
+  "version": "0.1.41",
   "description": "Formats number, dates and file sizes as human readable strings",
@@ -5,0 +5,0 @@ "main": "./dist/@deveox/humanize.cjs",

README.md

@@ -1,2 +0,39 @@
-[![codecov](https://codecov.io/gh/deveox/humanize/branch/main/graph/badge.svg?token=TSPKNXWIWB)](https://codecov.io/gh/deveox/humanize)
-https://img.shields.io/bundlephobia/minzip/@deveox/humanize?label=size
+![version](https://img.shields.io/npm/v/@deveox/humanize?label=Version) [![codecov](https://codecov.io/gh/deveox/humanize/branch/main/graph/badge.svg?token=TSPKNXWIWB)](https://codecov.io/gh/deveox/humanize) ![size](https://img.shields.io/bundlephobia/minzip/@deveox/humanize?label=Size) ![releases](https://img.shields.io/github/downloads/deveox/humanize/total?label=GitHub%20Downloads) ![npm](https://img.shields.io/npm/dm/@deveox/humanize?label=Downloads) ![license](https://img.shields.io/github/license/deveox/humanize?label=License)
+
+# @deveox/humanize
+
+This library formats number, dates and file sizes to human readable strings.
+
+- Lightweight
+- Fully tree-shakable: import only what you need
+- TypeScript: entirely typed
+- `BigInt` support
+- Test coverage > 95%
+- Hight standards of code quality and contribution
+
+## Installation
+
+```shell
+npm i @deveox/humanize
+
+```
+
+## Documentation
+
+TBD
+
+## Contributing
+
+Contributions are welcome and will be fully credited! Check our [Contribution Guide](https://github.com/deveox/.github/blob/d164dff052059540a3e50d9c1600da16e01f0937/CONTRIBUTING.md).
+
+## Development Environment
+
+TBD
+
+## Changelog
+
+You can see changes history [here](CHANGELOG.md).
+
+## License
+
+© David Yunevich, [MIT](LICENSE)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

40957

increased by3.22%

Number of lines in readme file

40

increased by1233.33%

No dependency changes