Skip to content

chore: update readme #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
targos merged 1 commit into from
Nov 26, 2025
Merged

chore: update readme #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 8 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
# hclust
# ml-hclust

[![NPM version][npm-image]][npm-url]
[![build status][ci-image]][ci-url]
[![Test coverage][codecov-image]][codecov-url]
[![npm download][download-image]][download-url]
[![NPM version](https://img.shields.io/npm/v/ml-hclust.svg)](https://www.npmjs.com/package/ml-hclust)
[![npm download](https://img.shields.io/npm/dm/ml-hclust.svg)](https://www.npmjs.com/package/ml-hclust)
[![test coverage](https://img.shields.io/codecov/c/github/mljs/hclust.svg)](https://codecov.io/gh/mljs/hclust)
[![license](https://img.shields.io/npm/l/ml-hclust.svg)](https://github.com/mljs/hclust/blob/main/LICENSE)

Hierarchical clustering algorithms in JavaScript.

## Installation

`npm i ml-hclust`
```console
npm install ml-hclust
```

## [API Documentation](https://mljs.github.io/hclust/)

Expand Down Expand Up @@ -48,12 +50,3 @@ npm test
## License

[MIT](./LICENSE)

[npm-image]: https://img.shields.io/npm/v/ml-hclust.svg
[npm-url]: https://npmjs.org/package/ml-hclust
[codecov-image]: https://img.shields.io/codecov/c/github/mljs/hclust.svg
[codecov-url]: https://codecov.io/gh/mljs/hclust
[ci-image]: https://github.com/mljs/hclust/workflows/Node.js%20CI/badge.svg?branch=main
[ci-url]: https://github.com/mljs/hclust/actions?query=workflow%3A%22Node.js+CI%22
[download-image]: https://img.shields.io/npm/dm/ml-hclust.svg
[download-url]: https://npmjs.org/package/ml-hclust
Loading