minor readme touchup

StoneCypher · Jan 19, 2021 · 19cd4a3 · 19cd4a3
1 parent baf1ff6
commit 19cd4a3
Show file tree

Hide file tree

Showing 13 changed files with 180 additions and 118 deletions.
diff --git a/README.md b/README.md
@@ -117,8 +117,15 @@ const TrafficLightWithOff = sm`
 
 <img src="https://raw.githubusercontent.com/StoneCypher/jssm/master/src/assets/doc%20light%20styled.png"/>
 
+<br/>
+
+What if the machine was lighting fast, able to do tens of millions of transitions per second?
+
+<img src="https://raw.githubusercontent.com/StoneCypher/jssm/master/src/assets/home%20pc%20speed.png"/>
+
+<br/>
+
 * What if the machine and language had extensive 100% test coverage with thousands of cases?
-* What if the machine was lighting fast, able to do 100k+ transitions per second?
 * What if the machine gave extensive Typescript introspection support?
 * What if the machine had been around and active since ?
 * What if the machine was MIT end to end?

diff --git a/dist/es6/version.js b/dist/es6/version.js
@@ -1,2 +1,2 @@
-const version = "5.35.2";
+const version = "5.35.3";
 export { version };
diff --git a/dist/jssm.es5.cjs.js b/dist/jssm.es5.cjs.js
diff --git a/dist/jssm.es5.cjs.nonmin.js b/dist/jssm.es5.cjs.nonmin.js
@@ -15612,7 +15612,7 @@ function peg$parse(input, options) {
     }
 }
 
-const version = "5.35.2";
+const version = "5.35.3";
 
 // whargarbl lots of these return arrays could/should be sets
 /* eslint-disable complexity */

diff --git a/dist/jssm.es5.iife.js b/dist/jssm.es5.iife.js
diff --git a/dist/jssm.es5.iife.nonmin.js b/dist/jssm.es5.iife.nonmin.js
@@ -15611,7 +15611,7 @@ var jssm = (function (exports) {
       }
   }
 
-  const version = "5.35.2";
+  const version = "5.35.3";
 
   // whargarbl lots of these return arrays could/should be sets
   /* eslint-disable complexity */

diff --git a/docs/docs/classes/machine.html b/docs/docs/classes/machine.html
diff --git a/docs/docs/index.html b/docs/docs/index.html
@@ -144,9 +144,12 @@ <h1>jssm</h1>
 </code></pre>
 				<br/>
 				<img src="https://raw.githubusercontent.com/StoneCypher/jssm/master/src/assets/doc%20light%20styled.png"/>
+				<br/>
+				<p>What if the machine was lighting fast, able to do tens of millions of transitions per second?</p>
+				<img src="https://raw.githubusercontent.com/StoneCypher/jssm/master/src/assets/home%20pc%20speed.png"/>
+				<br/>
 				<ul>
 					<li>What if the machine and language had extensive 100% test coverage with thousands of cases?</li>
-					<li>What if the machine was lighting fast, able to do 100k+ transitions per second?</li>
 					<li>What if the machine gave extensive Typescript introspection support?</li>
 					<li>What if the machine had been around and active since ?</li>
 					<li>What if the machine was MIT end to end?</li>

diff --git a/docs/docs/modules.html b/docs/docs/modules.html
@@ -102,7 +102,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> histograph</h3>
 					<div class="tsd-signature tsd-kind-icon">histograph<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol"> = ...</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/5f1d7b6/src/ts/jssm_util.ts#L56">jssm_util.ts:56</a></li>
+							<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/baf1ff6/src/ts/jssm_util.ts#L56">jssm_util.ts:56</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -112,17 +112,17 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> seq</h3>
 					<div class="tsd-signature tsd-kind-icon">seq<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol"> = ...</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/5f1d7b6/src/ts/jssm_util.ts#L47">jssm_util.ts:47</a></li>
+							<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/baf1ff6/src/ts/jssm_util.ts#L47">jssm_util.ts:47</a></li>
 						</ul>
 					</aside>
 				</section>
 				<section class="tsd-panel tsd-member tsd-kind-variable">
 					<a name="version" class="tsd-anchor"></a>
 					<h3><span class="tsd-flag ts-flagConst">Const</span> version</h3>
-					<div class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;5.35.2&quot;</span></div>
+					<div class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;5.35.3&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/5f1d7b6/src/ts/version.ts#L2">version.ts:2</a></li>
+							<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/baf1ff6/src/ts/version.ts#L2">version.ts:2</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -132,7 +132,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> weighted_<wbr>histo_<wbr>ke
 					<div class="tsd-signature tsd-kind-icon">weighted_<wbr>histo_<wbr>key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol"> = ...</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/5f1d7b6/src/ts/jssm_util.ts#L80">jssm_util.ts:80</a></li>
+							<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/baf1ff6/src/ts/jssm_util.ts#L80">jssm_util.ts:80</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -142,7 +142,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> weighted_<wbr>rand_<wbr>sel
 					<div class="tsd-signature tsd-kind-icon">weighted_<wbr>rand_<wbr>select<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol"> = ...</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/5f1d7b6/src/ts/jssm_util.ts#L19">jssm_util.ts:19</a></li>
+							<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/baf1ff6/src/ts/jssm_util.ts#L19">jssm_util.ts:19</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -152,7 +152,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> weighted_<wbr>sample_<wbr>s
 					<div class="tsd-signature tsd-kind-icon">weighted_<wbr>sample_<wbr>select<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol"> = ...</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/5f1d7b6/src/ts/jssm_util.ts#L69">jssm_util.ts:69</a></li>
+							<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/baf1ff6/src/ts/jssm_util.ts#L69">jssm_util.ts:69</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -169,7 +169,7 @@ <h3>arrow_<wbr>direction</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/5f1d7b6/src/ts/jssm.ts#L49">jssm.ts:49</a></li>
+									<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/baf1ff6/src/ts/jssm.ts#L49">jssm.ts:49</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -192,7 +192,7 @@ <h3>arrow_<wbr>left_<wbr>kind</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/5f1d7b6/src/ts/jssm.ts#L91">jssm.ts:91</a></li>
+									<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/baf1ff6/src/ts/jssm.ts#L91">jssm.ts:91</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -215,7 +215,7 @@ <h3>arrow_<wbr>right_<wbr>kind</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/5f1d7b6/src/ts/jssm.ts#L133">jssm.ts:133</a></li>
+									<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/baf1ff6/src/ts/jssm.ts#L133">jssm.ts:133</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -238,7 +238,7 @@ <h3>compile</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/5f1d7b6/src/ts/jssm.ts#L308">jssm.ts:308</a></li>
+									<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/baf1ff6/src/ts/jssm.ts#L308">jssm.ts:308</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-type-parameters-title">Type parameters</h4>
@@ -267,7 +267,7 @@ <h3>make</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/5f1d7b6/src/ts/jssm.ts#L410">jssm.ts:410</a></li>
+									<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/baf1ff6/src/ts/jssm.ts#L410">jssm.ts:410</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-type-parameters-title">Type parameters</h4>
@@ -296,7 +296,7 @@ <h3>parse</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/5f1d7b6/src/ts/jssm.ts#L218">jssm.ts:218</a></li>
+									<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/baf1ff6/src/ts/jssm.ts#L218">jssm.ts:218</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -322,7 +322,7 @@ <h3>sm</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/5f1d7b6/src/ts/jssm.ts#L1071">jssm.ts:1071</a></li>
+									<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/baf1ff6/src/ts/jssm.ts#L1071">jssm.ts:1071</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-type-parameters-title">Type parameters</h4>
@@ -354,7 +354,7 @@ <h3>transfer_<wbr>state_<wbr>properties</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/5f1d7b6/src/ts/jssm.ts#L418">jssm.ts:418</a></li>
+									<li>Defined in <a href="https://github.com/StoneCypher/jssm/blob/baf1ff6/src/ts/jssm.ts#L418">jssm.ts:418</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>

diff --git a/docs/index.html b/docs/index.html
@@ -2,18 +2,44 @@
 <html>
 
   <head>
+
+    <link rel="preconnect" href="https://fonts.gstatic.com"/>
+    <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@300;700&display=swap" rel="stylesheet"/>
+
+    <style type="text/css">
+      html, body   { margin: 0; padding: 0; border: 0; height: 100%; }
+      body         { padding: 2em 3em; font-size: 200%; }
+      h1, p, li    { font-family: "Open Sans", sans-serif; font-weight: 300; }
+      h1           { font-weight: 700; margin-bottom: 2em;}
+      li           { list-style-type: circle; }
+      a, a:visited { color: #05f; text-decoration: none; }
+      tt           { background-color: #f8f8f8; }
+    </style>
+
   </head>
 
   <body>
 
-    <h1>JSSM</h1>
+    <h1>JSSM repo site</h1>
+
+    <p>There isn't actually anything here.  You're probably looking for:</p>
 
     <ul>
-      <li><a href="https://github.com/StoneCypher/jssm">Github</a></li>
-      <li><a href="https://www.npmjs.com/package/jssm">NPM</a></li>
+      <li><a href="https://github.com/StoneCypher/fsl/issues">Issue tracker</a></li>
       <li><a href="https://stonecypher.github.io/jssm/docs/">Library documentation</a></li>
-      <li><a href="https://coveralls.io/github/StoneCypher/jssm">Coveralls</a></li>
-      <li><a href="https://codeclimate.com/github/StoneCypher/jssm">Code Climate</a></li>
+      <li><a href="https://github.com/StoneCypher/jssm">Github repo</a> (we use the <tt>fsl</tt> repo, not <tt>jssm</tt>, for issues)</li>
+      <li><a href="https://www.npmjs.com/package/jssm">NPM page</a></li>
+      <li><strike>Tutorials</strike></li>
+      <li><strike>Language standard</strike></li>
+    </ul>
+
+    <br/><br/>
+
+    <p>Less commonly, you might be looking for</p>
+
+    <ul>
+      <li><a href="https://github.com/StoneCypher/jssm/actions">Build history</a></li>
+      <li><a href="https://coveralls.io/github/StoneCypher/jssm">Coveralls report</a></li>
     </ul>
 
   </body>

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "jssm",
-  "version": "5.35.2",
+  "version": "5.35.3",
   "engines": {
     "node": ">=10.0.0"
   },

diff --git a/src/site/index.html b/src/site/index.html
@@ -2,18 +2,44 @@
 <html>
 
   <head>
+
+    <link rel="preconnect" href="https://fonts.gstatic.com"/>
+    <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@300;700&display=swap" rel="stylesheet"/>
+
+    <style type="text/css">
+      html, body   { margin: 0; padding: 0; border: 0; height: 100%; }
+      body         { padding: 2em 3em; font-size: 200%; }
+      h1, p, li    { font-family: "Open Sans", sans-serif; font-weight: 300; }
+      h1           { font-weight: 700; margin-bottom: 2em;}
+      li           { list-style-type: circle; }
+      a, a:visited { color: #05f; text-decoration: none; }
+      tt           { background-color: #f8f8f8; }
+    </style>
+
   </head>
 
   <body>
 
-    <h1>JSSM</h1>
+    <h1>JSSM repo site</h1>
+
+    <p>There isn't actually anything here.  You're probably looking for:</p>
 
     <ul>
-      <li><a href="https://github.com/StoneCypher/jssm">Github</a></li>
-      <li><a href="https://www.npmjs.com/package/jssm">NPM</a></li>
+      <li><a href="https://github.com/StoneCypher/fsl/issues">Issue tracker</a></li>
       <li><a href="https://stonecypher.github.io/jssm/docs/">Library documentation</a></li>
-      <li><a href="https://coveralls.io/github/StoneCypher/jssm">Coveralls</a></li>
-      <li><a href="https://codeclimate.com/github/StoneCypher/jssm">Code Climate</a></li>
+      <li><a href="https://github.com/StoneCypher/jssm">Github repo</a> (we use the <tt>fsl</tt> repo, not <tt>jssm</tt>, for issues)</li>
+      <li><a href="https://www.npmjs.com/package/jssm">NPM page</a></li>
+      <li><strike>Tutorials</strike></li>
+      <li><strike>Language standard</strike></li>
+    </ul>
+
+    <br/><br/>
+
+    <p>Less commonly, you might be looking for</p>
+
+    <ul>
+      <li><a href="https://github.com/StoneCypher/jssm/actions">Build history</a></li>
+      <li><a href="https://coveralls.io/github/StoneCypher/jssm">Coveralls report</a></li>
     </ul>
 
   </body>

diff --git a/src/ts/version.ts b/src/ts/version.ts
@@ -1,3 +1,3 @@
 
-const version: string = "5.35.2";
+const version: string = "5.35.3";
 export { version };