indian-music-sequence-generator - npm Package Compare versions

Comparing version 0.0.1 to 0.1.1

package.json

 {
   "name": "indian-music-sequence-generator",
-  "version": "0.0.1",
+  "version": "0.1.1",
   "description": "Generate classical indian music notation sequences for practice",
@@ -9,3 +9,3 @@ "main": "src.js",
     "test:watch": "jest --watchAll",
-    "lint": "node_modules/.bin/eslint . --ext .js"
+    "lint": "eslint . --ext .js"
   },
@@ -12,0 +12,0 @@ "engines": {

README.md

@@ -1,5 +0,37 @@
-# Classical Indian Vocal Training
+# ["sr", "sg", "sm", "sp"]
 
 [![Lint and test](https://github.com/jujhars13/indian-vocal-training/actions/workflows/main.yaml/badge.svg)](https://github.com/jujhars13/indian-vocal-training/actions/workflows/main.yaml)
 
-Vocal training exercises from the classical Indian tradition
+Generate various classical indian music notational sequences to be used for vocal and instrumental practice
+
+## Current Sequences
+
+- two note jumps: eg `["sr", "sg", "sm", "sp"]`
+
+## Current Taaths (scales)
+
+- Bilaval
+- Kalyaan
+
+## Usage
+
+```javascript
+const generator = require("indian-music-sequence-generator");
+
+// generate a 5 note sequence in Bilaval
+console.log(generator.twoNoteJumps("bilaval", 5));
+```
+
+## Development
+
+```bash
+
+# run tests
+npm run test
+
+# run tests with watch
+npm run test:watch
+
+# run linting
+npm run lint
+```

twoNoteJumps/src.js

@@ -10,2 +10,3 @@ const scales = require("../scales.js");
 const generateSequence = (numberOfNotes = 5) => {
+  console.debug({ numberOfNotes });
   return [
@@ -12,0 +13,0 @@ {

No alert changes

Improved metrics

Total package byte prevSize

41474

increased by1.19%

Lines of code

138

increased by0.73%

Number of lines in readme file

38

increased by533.33%

No dependency changes