Work in progress pending chord-symbol

README.md

@@ -1,6 +1,6 @@
 # ireal-musicxml
 
-iReal Pro to MusicXML converter
+iReal Pro to MusicXML converter.
 
 [![npm version](https://badge.fury.io/js/ireal-musicxml.svg)](https://badge.fury.io/js/ireal-musicxml)
 ![GitHub Build Status](https://github.com/infojunkie/ireal-musicxml/workflows/Test/badge.svg)
@@ -12,10 +12,10 @@ iReal Pro to MusicXML converter
 # Usage
 
 ```javascript
-import * as iReal2MusicXML from 'ireal-musicxml'
+import * as iRealMusicXml from 'ireal-musicxml'
 const ireal = // Content of HTML file generated by iReal Pro or irealb:// URI
-const playlistSync = iReal2MusicXML.convertSync(ireal)
-const playlistAsync = await iReal2MusicXML.convert(ireal)
+const playlistSync = iRealMusicXml.convertSync(ireal)
+const playlistAsync = await iRealMusicXml.convert(ireal)
 // => {
 //   name:              // Playlist name
 //   songs: [{
@@ -33,23 +33,22 @@ const playlistAsync = await iReal2MusicXML.convert(ireal)
 //   }]
 // }
 
-const playlistManual = new iReal2MusicXML.Playlist(ireal)
+const playlistManual = new iRealMusicXml.Playlist(ireal)
 // => Same as above minus `musicXml` attribute
-const musicXml = iReal2MusicXML.MusicXML.convert(playlistManual.songs[0])
+const musicXml = iRealMusicXml.MusicXML.convert(playlistManual.songs[0])
 // => MusicXML output
 ```
 
 # Development
 
-`xmllint` is required to run tests (but NOT at runtime). Tests are used to ensure that the generated MusicXML is valid.
+`xmllint` is required to run tests and the demo cli tool (but NOT for the library). Tests are used to ensure that the generated MusicXML is valid.
 
 ```
 npm install
 npm run test
+./demo/cli/ireal-musicxml.js test/data/jazz.txt --songs=Blues --validate
 ```
 
-Check out the demos for example usage under `demo/`.
-
 # Documentation
 - More information [about the iReal Pro format](doc/irealpro.md).
 - More information [about the MusicXML format](https://w3c.github.io/musicxml/).

lib/ireal-musicxml.d.ts → build/ireal-musicxml.d.ts

@@ -162,15 +162,47 @@ export class ConversionOptions {
    */
   notehead?: string;
   /**
-   * Log level (default: Warn).
+   * Size of note head to use for the chord note (default: large).
+   * https://www.w3.org/2021/06/musicxml40/musicxml-reference/data-types/font-size/
+   */
+  noteheadSize?: string;
+  /**
+   * Whether to output encoding date (default: yes).
+   * https://www.w3.org/2021/06/musicxml40/musicxml-reference/elements/encoding-date/
+   */
+  date?: boolean;
+  /**
+   * Whether to display the clef (i.e. set its @print-object attribute) (default: no).
+   * https://www.w3.org/2021/06/musicxml40/musicxml-reference/elements/clef/
+   */
+  clef?: boolean;
+  /**
+   * Whether to display the key signature (i.e. set its @print-object attribute) (default: no).
+   * https://www.w3.org/2021/06/musicxml40/musicxml-reference/elements/key/
+   */
+  keySignature?: boolean;
+  /**
+   * Page width in millimeters (default: A4 = 210mm).
+   */
+  pageWidth?: number;
+  /**
+   * Page height in millimeters (default: A4 = 297mm).
+   */
+  pageHeight?: number;
+  /**
+   * Page margin in millimeters (default: 15mm).
+   */
+  pageMargin?: number;
+  /**
+   * Log level (default: LogLevel.Warn).
    */
   logLevel?: LogLevel;
 }
 
 /**
  * MusicXML converter.
  */
-export class MusicXML {
+export class Converter {
   /**
    * Default conversion options.
    */