Update README.

Improve comments. http:// => https:// Fix some broken URLs.
0xfe · Nov 13, 2021 · a835afd · a835afd
1 parent 56ba6ea
commit a835afd
Show file tree

Hide file tree

Showing 8 changed files with 1,285 additions and 1,312 deletions.
diff --git a/README.md b/README.md
@@ -1,40 +1,49 @@
-# VexFlow 3
+# VexFlow 4 (beta)
 
-A JavaScript library for rendering music notation.
+A JavaScript / TypeScript library for rendering music notation.
 Copyright (c) 2010 Mohit Muthanna Cheppudira
 
 ## Sponsor this Project
 
-If you use VexFlow in your app, startup, institution, and find it useful, please consider sponsoring its
-development here: https://github.com/sponsors/0xfe.
+If you use VexFlow in your app, startup, institution, and find it useful, please consider sponsoring its development here: https://github.com/sponsors/0xfe.
 
-## Need Help? Ask on the [Vexflow Google Group](https://groups.google.com/forum/?fromgroups#!forum/vexflow).
+## Need Help?
+
+Ask on the [Vexflow Google Group](https://groups.google.com/forum/?fromgroups#!forum/vexflow).
 
 ## What is VexFlow?
 
-VexFlow is an open-source web-based music notation rendering API. It is written
-completely in JavaScript, and runs right in the browser. VexFlow supports HTML5
+VexFlow is an open-source web-based music notation rendering API. It is written in TypeScript, and runs right in the browser. VexFlow supports HTML
 Canvas and SVG, and runs on all modern browsers.
 
-Go try out [The VexFlow Tutorial](https://github.com/0xfe/vexflow/wiki/The-VexFlow-Tutorial) to
-learn how to use VexFlow. Also learn to use the simpler EasyScore API in the [Using EasyScore](https://github.com/0xfe/vexflow/wiki/Using-EasyScore) guide.
+Go try out [The VexFlow Tutorial](https://github.com/0xfe/vexflow/wiki/Tutorial) to learn how to use VexFlow.
 
 ## Quick Start
 
 ### Using NPM
 
-    $ npm install vexflow
+To install version 4.0.0-beta:
+
+```shell
+$ npm install vexflow@beta
+```
+
+To install version 3.0.9:
+
+```shell
+$ npm install vexflow
+```
 
 ### Using the HTML `script` Tag
 
-The releases are served via [unpkg.com](http://unpkg.com).
+The releases are served via [unpkg.com](https://unpkg.com).
 
 - Debug version: https://unpkg.com/vexflow/releases/vexflow-debug.js
 - Minified version: https://unpkg.com/vexflow/releases/vexflow-min.js
 
 ### Using EasyScore
 
-The EasyScore API is a quick way to create simple music notation in VexFlow. See running example in [this jsfiddle](https://jsfiddle.net/2pbh9xq0/).
+The EasyScore API is a quick way to create simple music notation in VexFlow. See a running example in [this jsfiddle](https://jsfiddle.net/2pbh9xq0/).
 
 ```javascript
 import Vex from 'vexflow';
@@ -59,11 +68,11 @@ system
 vf.draw();
 ```
 
-Learn more about EasyScore at: [Using EasyScore](https://github.com/0xfe/vexflow/wiki/Using-EasyScore).
+Learn the EasyScore API in the [Using EasyScore](https://github.com/0xfe/vexflow/wiki/Using-EasyScore) guide.
 
 ### Using the Native API
 
-The example code below renders a VexFlow stave using SVG. See running example in this [jsfiddle](https://jsfiddle.net/j6dpazx2/).
+The example code below renders a VexFlow stave using SVG. See a running example in this [jsfiddle](https://jsfiddle.net/j6dpazx2/).
 
 ```javascript
 import Vex from 'vexflow';
@@ -77,7 +86,7 @@ const renderer = new VF.Renderer(div, VF.Renderer.Backends.SVG);
 // Configure the rendering context.
 renderer.resize(500, 500);
 const context = renderer.getContext();
-context.setFont('Arial', 10).setBackgroundFillStyle('#eed');
+context.setFont('Arial', 10);
 
 // Create a stave of width 400 at position 10, 40 on the canvas.
 const stave = new VF.Stave(10, 40, 400);
@@ -100,7 +109,7 @@ Sponsor Vexflow: https://github.com/sponsors/0xfe
 ## MIT License
 
 Copyright (c) Mohit Muthanna Cheppudira 2010 <br/>
-0xFE <mohit@muthanna.com> http://www.vexflow.com
+0xFE <mohit@muthanna.com> https://www.vexflow.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/docs/index.html b/docs/index.html
@@ -1,33 +1,33 @@
 <html>
 <head>
   <title>VexFlow - HTML5 Music Engraving</title>
-  <link href='http://fonts.googleapis.com/css?family=OFL+Sorts+Mill+Goudy+TT|Yanone+Kaffeesatz|Tangerine'
+  <link href='https://fonts.googleapis.com/css?family=OFL+Sorts+Mill+Goudy+TT|Yanone+Kaffeesatz|Tangerine'
    rel='stylesheet' type='text/css'>
-  <link href="http://vwww.vexflow.com/vextab/tabdiv.css" media="screen" rel="Stylesheet" type="text/css" />
-  <link href="http://www.vexflow.com/vextab/style.css" media="screen" rel="Stylesheet" type="text/css" />
+  <link href="https://www.vexflow.com/vextab/tabdiv.css" media="screen" rel="Stylesheet" type="text/css" />
+  <link href="https://www.vexflow.com/vextab/style.css" media="screen" rel="Stylesheet" type="text/css" />
 
   <!-- VexFlow Compiled Source -->
   <script src="../build/vexflow/vexflow-debug.js"></script>
+  <!-- VexFlow 1.2.23 built on 2014-11-25. -->
   <script src="vextab/support/vexflow-min.js"></script>
 
-  <script src="http://cdnjs.cloudflare.com/ajax/libs/lodash.js/2.4.1/lodash.js"></script>
-  <script src="http://code.jquery.com/jquery-2.1.0.min.js"></script>
-  <script src="http://www.vexflow.com/support/tabdiv-debug.js"></script>
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/lodash.js/2.4.1/lodash.js"></script>
+  <script src="https://code.jquery.com/jquery-2.1.0.min.js"></script>
+  <script src="https://www.vexflow.com/support/tabdiv-debug.js"></script>
 </head>
 
 <body>
   <div class="vex">
-    <a href="http://my.vexflow.com">My VexFlow</a> |
-    <a href="http://vexflow.com/vextab/">VexTab</a> |
-    <a href="http://0xfe.blogspot.com">0xfe</a>
+    <a href="https://vexflow.com/vextab/">VexTab</a> |
+    <a href="https://0xfe.blogspot.com">0xfe</a>
   </div>
 
   <div class="header">
     <h1>VexFlow</h1>
     <div class="main">
       <b>Music Engraving in JavaScript and HTML5</b>
     </div>
-    v2.0 by <a href="http://0xfe.blogspot.com">0xfe</a>.
+    v2.0 by <a href="https://0xfe.blogspot.com">0xfe</a>.
   </div>
 
   <div class="content">
@@ -68,14 +68,14 @@ <h2>Where Do I Start?</h2>
       <p/>
       <ul>
         <li>The <a href="https://chrome.google.com/webstore/detail/vextab-music-notation/pjggkphnejbllmmkmmgibonkbbhfjnkk">VexTab Google Docs add-on</a> lets you add music notation right in your Google Documents.</li>
-        <li>You can use the <a href="https://chrome.google.com/webstore/detail/npcffdibegeppkebphaghnpkcjcpopjf">VexTab Chrome Extension</a> to write and share musical snippets hosted on <a href="http://imgur.com">imgur</a> right from your browser.</li>
-        <li>The <a href="http://www.vexflow.com/vextab/playground/">VexTab Playground</a>
-        is a simple online application to quickly create and post music notation to <a href="http://imgur.com">imgur</a>.
+        <li>You can use the <a href="https://chrome.google.com/webstore/detail/npcffdibegeppkebphaghnpkcjcpopjf">VexTab Chrome Extension</a> to write and share musical snippets hosted on <a href="https://imgur.com">imgur</a> right from your browser.</li>
+        <li>The <a href="https://www.vexflow.com/vextab/playground/">VexTab Playground</a>
+        is a simple online application to quickly create and post music notation to <a href="https://imgur.com">imgur</a>.
       </ul>
       <p/>
       If you're a programmer interested in rendering music notation in your
       own applications, take a look at
-    <a href="https://github.com/0xfe/vexflow/wiki/The-VexFlow-Tutorial">The VexFlow Tutorial</a>.
+    <a href="https://github.com/0xfe/vexflow/wiki/Tutorial">The VexFlow Tutorial</a>.
     </div>
 
 
@@ -86,12 +86,12 @@ <h2>Features</h2>
       But it can render a mean score.
 
       <p/>Have a look
-      at the <a href="http://www.vexflow.com/tests/">tests</a> page for a comprehensive list of features.
+      at the <a href="https://www.vexflow.com/tests/">tests</a> page for a comprehensive list of features.
     </div>
 
     <h2>What is VexTab?</h2>
     <div class="description">
-      <a href="http://vexflow.com/vextab/">VexTab</a> is an easy-to-use
+      <a href="https://vexflow.com/vextab/">VexTab</a> is an easy-to-use
       language to quickly create, edit, and render standard notation and guitar
       tablature.
       <p/>
@@ -102,13 +102,13 @@ <h2>What is VexTab?</h2>
     <h2>The Code</h2>
     <div class="description">
       VexFlow is distributed under the MIT license, and all the code is
-      available at the <a href="http://github.com/0xfe/vexflow">VexFlow GitHub
+      available at the <a href="https://github.com/0xfe/vexflow">VexFlow GitHub
         Repository</a>.
 
       <p/>
       VexTab is an open specification and the reference implementation is
       open source. This implementation is free for non-commercial use. See details
-      at the <a href="http://github.com/0xfe/vextab">VexTab GitHub
+      at the <a href="https://github.com/0xfe/vextab">VexTab GitHub
         Repository</a>.
     </div>
 
@@ -118,19 +118,18 @@ <h2>More Stuff</h2>
       and audio on the web. Try these out:
       <p/>
       <ul>
-        <li><a href="http://vexflow.com/vexwarp/">VexWarp</a> - An online tool for slowing down, stretching, pitch shifting, and looping music and audio. Great for practising and transcribing.</li>
+        <li><a href="https://vexflow.com/vexwarp/">VexWarp</a> - An online tool for slowing down, stretching, pitch shifting, and looping music and audio. Great for practising and transcribing.</li>
         <li><a href="https://chrome.google.com/webstore/detail/vexwarp/nkdmbkieeegbiockljbbebpdafnbckfj">VexWarp Chrome App</a> - An offline version of VexWarp bundled as a Google Chrome Application.</li>
-        <li><a href="http://vexflow.com/vexchords/">VexChords</a> - Guitar Chord charts rendered right in the browser, with source code.</li>
+        <li><a href="https://vexflow.com/vexchords/">VexChords</a> - Guitar Chord charts rendered right in the browser, with source code.</li>
         <li><a href="https://chrome.google.com/webstore/detail/vextab-music-notation/npcffdibegeppkebphaghnpkcjcpopjf">VexTab Chrome Extension</a>
           - Paste music notation in your blog and forum posts, documents, and messages.</li>
       </ul>
     </div>
 
     <h2>Stay in Touch</h2>
     Keep up with changes at
-    <a href="http://twitter.com/11111110b">@11111110b</a>,
-    <a href="http://0xfe.blogspot.com">the 0xFE blog</a>, or
-    <a href="https://plus.google.com/111867441083313519234/posts">Google Plus</a>.
+    <a href="https://twitter.com/11111110b">@11111110b</a>,
+    <a href="https://0xfe.blogspot.com">the 0xFE blog</a>.
   </div>
 <script>
  var _gaq = _gaq || [];
@@ -140,7 +139,7 @@ <h2>Stay in Touch</h2>
 
   (function() {
     var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
-    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'https://www') + '.google-analytics.com/ga.js';
     var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
   })();
 </script>