@libraz/libcantus 0.9.0 → 0.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -5,11 +5,13 @@ harmony, recognize what you're hearing, voice and reharmonize progressions, and
5
5
  generate parts (bass, countermelody, drums, rhythm) — all with no runtime
6
6
  dependencies.
7
7
 
8
- [![CI](https://github.com/libraz/libcantus/actions/workflows/ci.yml/badge.svg)](https://github.com/libraz/libcantus/actions/workflows/ci.yml)
8
+ [![CI](https://img.shields.io/github/actions/workflow/status/libraz/libcantus/ci.yml?branch=main&label=CI)](https://github.com/libraz/libcantus/actions)
9
+ [![npm](https://img.shields.io/npm/v/@libraz/libcantus)](https://www.npmjs.com/package/@libraz/libcantus)
9
10
  [![codecov](https://codecov.io/gh/libraz/libcantus/branch/main/graph/badge.svg)](https://codecov.io/gh/libraz/libcantus)
11
+ [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](https://github.com/libraz/libcantus/blob/main/LICENSE)
10
12
  [![TypeScript](https://img.shields.io/badge/TypeScript-strict-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
11
13
  [![Node.js](https://img.shields.io/badge/Node.js-%E2%89%A522-339933?logo=node.js&logoColor=white)](https://nodejs.org/)
12
- [![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
14
+ [![docs](https://img.shields.io/badge/docs-API%20reference-b5892e)](https://libraz.github.io/libcantus/)
13
15
 
14
16
  ## What can you do with it?
15
17
 
@@ -286,6 +288,12 @@ Meter helpers (`TimeSignature`, `parseTimeSignature`, `beatsPerBar`,
286
288
  `metricWeight`, `isStrongBeat`, `tuplet`) cover simple and compound meters and
287
289
  back the accent-aware generators.
288
290
 
291
+ ## Documentation
292
+
293
+ Full API reference — every export with signatures, categorized by domain and
294
+ with runnable examples — is generated from the source and published at
295
+ **[libraz.github.io/libcantus](https://libraz.github.io/libcantus/)**.
296
+
289
297
  ## License
290
298
 
291
299
  Apache-2.0