@libraz/libcantus 0.9.1 → 0.9.3

package/README.md

@@ -10,7 +10,7 @@ dependencies.
 [![codecov](https://codecov.io/gh/libraz/libcantus/branch/main/graph/badge.svg)](https://codecov.io/gh/libraz/libcantus)
 [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](https://github.com/libraz/libcantus/blob/main/LICENSE)
 [![TypeScript](https://img.shields.io/badge/TypeScript-strict-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
-[![Node.js](https://img.shields.io/badge/Node.js-%E2%89%A522-339933?logo=node.js&logoColor=white)](https://nodejs.org/)
+[![Node.js](https://img.shields.io/badge/Node.js-22.x-339933?logo=node.js&logoColor=white)](https://nodejs.org/)
 [![docs](https://img.shields.io/badge/docs-API%20reference-b5892e)](https://libraz.github.io/libcantus/)
 
 ## What can you do with it?
@@ -47,6 +47,21 @@ so — like `rhythm`, `drums`, and `detectKey` — they are exposed as functions
 yarn add @libraz/libcantus
 ```
 
+## Subpath imports
+
+The package root exports everything. To pull in a single layer, import its
+subpath instead:
+
+```ts
+import { Chord, Key, Note } from '@libraz/libcantus/model'; // class API
+import { majorKey, makeChord } from '@libraz/libcantus/theory'; // scales, chords
+import { generateDrums, generateProgression } from '@libraz/libcantus/generate';
+import { analyzeArrangement, detectKey } from '@libraz/libcantus/analyze';
+import { parseNote, edo } from '@libraz/libcantus/core'; // pitch, meter, tuning
+```
+
+The layers are `core`, `theory`, `analyze`, `generate`, and `model`.
+
 ## Quick start
 
 The class API chains immutably and carries key context, so analysis needs no
@@ -230,11 +245,12 @@ Seeded, deterministic generators for melody and accompaniment:
 ```ts
 import {
   generateBassLine, generateCounterMelody, generateDrums, generateRhythm,
-  generateMotif, parseTimeSignature,
+  generateMotif, majorKey, parseTimeSignature,
 } from '@libraz/libcantus';
 
 generateRhythm(parseTimeSignature('4/4'), { seed: 1, density: 0.5 }); // strong-beat-weighted onsets
-generateMotif({ key: majorKey(0), length: 4, contour: 'arch', seed: 1 }); // a short melodic cell
+const motif = generateMotif({ key: majorKey(0), bars: 2, contour: 'arch', seed: 1 });
+motif.notes.length > 0; // true — a deterministic short melodic cell
 ```
 
 `humanize`, `extractGrooveTemplate`, and `applyGrooveTemplate` add a meter-aware