updated readme and readme updater (#632)

Author: joeyklee

README.md

@@ -21,46 +21,34 @@ ml5.js is heavily inspired by [Processing](https://processing.org/) and [p5.js](
 
 There are several ways you can use the ml5.js library:
 
-<p id="latest-version">
 
-* You can use the latest version (0.3.1) by adding it to the head section of your HTML document:
 
-**v0.3.1**
-```javascript
-<script src="https://unpkg.com/[email protected]/dist/ml5.min.js" type="text/javascript"></script>
-```
 
-</p data-id="latest-version">
-
-
-
-* If you need to use an earlier version for any reason, you can change the version number.
 
+<p id="latest-version">
 
+* You can use the latest version (0.3.1) by adding it to the head section of your HTML document:
 
-<p id="legacy-versions">
+**v0.3.1**
 
-**v0.3.0**
+    <script src="https://unpkg.com/[email protected]/dist/ml5.min.js" type="text/javascript"></script>
 
-    <script src="https://unpkg.com/[email protected]/dist/ml5.min.js" type="text/javascript"></script>
+</p data-id="latest-version">
+    
+    
 
 
-**v0.3.0**
-
-    <script src="https://unpkg.com/[email protected]/dist/ml5.min.js" type="text/javascript"></script>
-
-
-**v0.2.3**
-
-    <script src="https://unpkg.com/[email protected]/dist/ml5.min.js" type="text/javascript"></script>
-
-
-**v0.1.3**
 
-    <script src="https://unpkg.com/[email protected]/dist/ml5.min.js" type="text/javascript"></script>
+* If you need to use an earlier version for any reason, you can change the version number. The [previous versions of ml5 can be found here](https://www.npmjs.com/package/ml5). You can use those previous versions by replacing `<version>` with the ml5 version of interest:
 
+```js
+<script src="https://unpkg.com/ml5@<version>/dist/ml5.min.js" type="text/javascript"></script>
+```
 
-</p data-id="legacy-versions">
+For example:
+```js
+<script src="https://unpkg.com/[email protected]/dist/ml5.min.js" type="text/javascript"></script>
+```
 
 * You can also reference "latest", but we do not recommend this as your code may break as we update ml5.
 

scripts/updateReadme.js

@@ -1,15 +1,9 @@
 const fs = require('fs');
-const oldVersionNumber = process.env.pversion;
-
-function checkVersionGiven(){
-    if(oldVersionNumber === undefined){
-        console.log('🔥🔥🔥submit the previous version number 🔥🔥🔥');
-        process.exit(22);    
-    }   
-}
 
 function getReadme(fpath){
-    let readme = fs.readFileSync(fpath, 'utf8');
+
+    const readme = fs.readFileSync(fpath, 'utf8');
+
     return readme;
 }
 
@@ -22,7 +16,6 @@ function readPackageJson(fpath){
 function makeNewVersionString(newVersionNumber){
 
     const newVersionString = `
-
 <p id="latest-version">
 
 * You can use the latest version (${newVersionNumber}) by adding it to the head section of your HTML document:
@@ -31,41 +24,23 @@ function makeNewVersionString(newVersionNumber){
 
     <script src="https://unpkg.com/ml5@${newVersionNumber}/dist/ml5.min.js" type="text/javascript"></script>
 
-</p>
+</p data-id="latest-version">
     `
 
     return newVersionString;
 }
 
-function makeLegacyVersionString(oldVersionNumber){
-    const legacyVersionString = `
-
-<p id="legacy-versions">
-
-**v${oldVersionNumber}**
-
-    <script src="https://unpkg.com/ml5@${oldVersionNumber}/dist/ml5.min.js" type="text/javascript"></script>
-    `
-
-    return legacyVersionString
-}
-
 
 function make(){
-    checkVersionGiven();
-    let packageJson = readPackageJson('./package.json');
-    const newVersionNumber = packageJson.version;
-    
-    console.log(`updating version: ${oldVersionNumber} to version: ${newVersionNumber}`);
 
+    const packageJson = readPackageJson('./package.json');
+    const newVersionNumber = packageJson.version;
     const newVersionString = makeNewVersionString(newVersionNumber);
-    const legacyVersionString = makeLegacyVersionString(oldVersionNumber);
-    
+
+    console.log(`---- updating README to version ${newVersionNumber} ----`)
 
-    let readme = getReadme('./README.md');
-    let newReadme = readme.replace(/<p id="latest-version">([\s\S]*)<\/p data-id="latest-version">/g, newVersionString);
-    // add the last version to the legacy section
-    newReadme = readme.replace(/<p id="legacy-versions">/g, legacyVersionString);
+    const readme = getReadme('./README.md');
+    const newReadme = readme.replace(/<p id="latest-version">([\s\S]*)<\/p data-id="latest-version">/g, newVersionString);
 
     fs.writeFileSync('./README.md', newReadme);