rita 3.0.17 → 3.0.19

package/README.md

@@ -1,9 +1,9 @@
-<a href="https://github.com/dhowe/rjs3/actions"><img src="https://github.com/dhowe/rjs3/actions/workflows/node.js.yml/badge.svg" alt="ci tests"></a> <a href="https://www.gnu.org/licenses/gpl-3.0.en.html"><img src="https://img.shields.io/badge/license-GPL-orange.svg" alt="license"></a> <a href="https://www.npmjs.com/package/rita"><img src="https://img.shields.io/npm/v/rita.svg" alt="npm version"></a> <!--[![](https://data.jsdelivr.com/v1/package/npm/rita/badge)](https://www.jsdelivr.com/package/npm/rita)--> [![CDNJS](https://img.shields.io/cdnjs/v/rita.svg)](https://cdnjs.com/libraries/rita/) 
+<a href="https://github.com/dhowe/rjs3/actions"><img src="https://github.com/dhowe/rjs3/actions/workflows/node.js.yml/badge.svg" alt="ci tests"></a> <a href="https://www.npmjs.com/package/rita"><img src="https://img.shields.io/npm/v/rita.svg" alt="npm version"></a> <a href="https://www.gnu.org/licenses/gpl-3.0.en.html"><img src="https://img.shields.io/badge/license-GPL-orange.svg" alt="license"></a>
 
 
-## RiTa: tools for generative natural language
+## RiTa: tools for computational writing
 
-RiTa is implemented in JavaScript and Java, with a common [API](https://github.com/dhowe/rita4j/blob/master/README.md#api) for both, and is free/libre/open-source via the GPL license.
+RiTa is implemented in JavaScript and Java, with a common [API](https://github.com/dhowe/rita4j/blob/master/README.md#api) for both, and is free/libre/open-source.
 
 ### Features in v3.0
 
@@ -14,18 +14,21 @@ RiTa is implemented in JavaScript and Java, with a common [API](https://github.c
 * New options for generation via grammars and Markov chains
 * Published in ESM, CommonJS and as an IIFE
 
-Note: version 3.0 contains breaking changes -- please check the [release notes](https://rednoise.org/rita/#whats-new-wrapper)
+Note: version 3.0 contains breaking changes -- please check the [release notes](https://rednoise.org/rita/#whats-new)
 
 ### Installation
 
-* For node: `npm install rita`
-* For [browsers](#a-simple-sketch): ```<script src="https://unpkg.com/rita"></script>```
+* For [esm](#an-esm-browser-sketch): ```import { RiTa } from "https://esm.sh/rita";```
+* For [node](#with-nodejs-and-npm): `$ npm install rita`  
+   ```let { RiTa }  = require('rita');```
+* For [browsers](#a-simple-browser-sketch): ```<script src="https://unpkg.com/rita"></script>```
 * For [developers](#developing)
 
-### Example (node)
+
+### Example
 
 ```javascript
-let RiTa = require('rita');
+import { RiTa } from "https://esm.sh/rita";
 
 // to analyze a sentence
 let data = RiTa.analyze("The elephant took a bite!");
@@ -117,7 +120,7 @@ console.log(grammar.expand());
 
 ## RiScript
 
-RiScript is a writer-focused scripting language integrated with RiTa. It enables simple generative primitives within plain text for dynamic expansion at runtime. RiScript primitives can be used as part of any [RiTa grammar](https://rednoise.org/rita/reference/RiTa/grammar/) or executed directly using [RiTa.evaluate()](https://rednoise.org/rita/reference/RiTa/evaluate/). For more info, see [this interactive notebook](https://observablehq.com/@dhowe/riscript).
+RiScript is a minor language designed for writers working in computational media. RiScript primitives -- choices, symbols, gates, transforms, etc. -- can be used as part of any RiTa [grammar](https://rednoise.org/rita/reference/RiTa/grammar/) or executed directly using [RiTa.evaluate](https://rednoise.org/rita/reference/RiTa/evaluate/). For more info, see [this interactive notebook](https://observablehq.com/@dhowe/riscript) on observable.
 
 <br>
 
@@ -133,7 +136,7 @@ $ git clone https://github.com/dhowe/ritajs.git
 $ cd ritajs 
 $ npm install
 $ npm run build 
-$ npm run test
+$ npm test
 
 ```
 If all goes well, you should see a list of successful tests and find the library built in 'dist'
@@ -148,7 +151,7 @@ Please make contributions via [fork-and-pull](https://reflectoring.io/github-for
 
 ### Visual Studio Code
 
-Once you have things running with npm/mocha, you might also try [VSCode](https://code.visualstudio.com/).
+Once you have things running with npm/mocha/tsup, you might also try [VSCode](https://code.visualstudio.com/).
 
 Some of the following extensions may also be useful:
 
@@ -169,32 +172,49 @@ Here you can see the tests in the VSCode _Testing_ view
 * Github Repo:       [https://github.com/dhowe/rita](https://github.com/dhowe/rita)
 * Issues:       [https://github.com/dhowe/rita/issues](https://github.com/dhowe/rita/issues)
 * Reference:    [https://rednoise.org/rita/reference](http://rednoise.org/rita/reference)
+* RiScript:    [https://github.com/dhowe/riscript](https://github.com/dhowe/riscript)
 
 &nbsp;
 
 ## Quick Start 
 
-#### A simple sketch
+#### A simple browser sketch
  
 Create a new file on your desktop called 'test.html' with the following lines, save and drag it into a browser:
 
 ```html
 <html>
-  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js"></script>
   <script src="https://unpkg.com/rita"></script>
   <script>
     window.onload = function() {
       let words = RiTa.tokenize("The elephant took a bite!");
-      $('#content').text(words);
+      document.getElementById("content").innerHTML = words;
     };
   </script>
   <div id="content" width=200 height=200></div>
 <html>
 ```
 
+#### An ESM browser sketch
+ 
+Create a new file on your desktop called 'test.html' with the following lines, save and drag it into a browser:
+
+```html
+<html>
+<body>
+  <div id="content" width=200 height=200></div>
+  <script type="module">
+    import { RiTa } from "https://esm.sh/rita";
+    let words = RiTa.tokenize("The elephant took a bite!");
+    document.getElementById("content").innerHTML = words;
+  </script>
+</body>
+<html>
+```
+
 #### With [p5.js](http://p5js.org/)
  
-Create a new file on your desktop called 'test.html' and download the latest rita.js from [here](http://rednoise.org/rita/download/rita.min.js), add the following lines, save and drag it into a browser:
+Create a new file on your desktop called 'test.html' with the following lines, save and drag it into a browser:
 
 ```html
 <html>
@@ -204,13 +224,13 @@ Create a new file on your desktop called 'test.html' and download the latest rit
   function setup() {
 
     createCanvas(200,200);
-    background(50);
+    background(245);
+    textAlign(CENTER);
     textSize(20);
-    noStroke();
 
     let words = RiTa.tokenize("The elephant took a bite!")
     for (let i=0; i < words.length; i++) {
-        text(words[i], 50, 50 + i*20);
+        text(words[i], 100, 50 + i*20);
     }
   }
   </script>

package/dist/rita.cjs

@@ -42622,7 +42622,7 @@ RiTa2.conjugator = new conjugator_default(RiTa2);
 RiTa2.SILENT = false;
 RiTa2.SILENCE_LTS = false;
 RiTa2.PHONES = ["aa", "ae", "ah", "ao", "aw", "ay", "b", "ch", "d", "dh", "eh", "er", "ey", "f", "g", "hh", "ih", "iy", "jh", "k", "l", "m", "n", "ng", "ow", "oy", "p", "r", "s", "sh", "t", "th", "uh", "uw", "v", "w", "y", "z", "zh"];
-RiTa2.VERSION = "3.0.17";
+RiTa2.VERSION = "3.0.19";
 RiTa2.HAS_LEXICON = typeof __NOLEX__ === "undefined";
 RiTa2.FIRST = 1;
 RiTa2.SECOND = 2;