rita 2.8.31 → 3.0.8

package/LICENSE

@@ -1,7 +1,7 @@
                     GNU GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
 
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
@@ -645,7 +645,7 @@ the "copyright" line and a pointer to where the full notice is found.
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
@@ -664,11 +664,11 @@ might be different; for a GUI interface, you would use an "about box".
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
 For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
+<https://www.gnu.org/licenses/>.
 
   The GNU General Public License does not permit incorporating your program
 into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

package/README.md

@@ -1,19 +1,20 @@
-[![Build Status](https://travis-ci.org/dhowe/RiTaJS.svg?branch=master)](https://travis-ci.org/dhowe/ritajs)[![Unit Tests](https://github.com/dhowe/ritajs/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/dhowe/ritajs/actions?query=workflow%3A%22unit+tests%22) <a href="http://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.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/) 
 
 
 ## RiTa: tools for generative natural language
 
-RiTa is implemented in Java and JavaScript, 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 via the GPL license.
 
-### Features in v2.0
+### Features in v3.0
 
 * Smart lexicon search for words matching part-of-speech, syllable, stress and rhyme patterns
 * Fast, heuristic algorithms for inflection, conjugation, stemming, tokenization, and more
 * Letter-to-sound engine for feature analysis of arbitrary words (with/without lexicon)
 * Integration of the [RiScript](https://observablehq.com/@dhowe/riscript) scripting language, designed for writers
-* Powerful new options for generation via grammars and Markov chains
+* New options for generation via grammars and Markov chains
+* Published in ESM, CommonJS and as an IIFE
 
-Note: version 2.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-wrapper)
 
 ### Installation
 
@@ -26,10 +27,6 @@ Note: version 2.0 contains breaking changes -- please check the [release notes](
 ```javascript
 let RiTa = require('rita');
 
-// to find rhymes
-let rhymes = RiTa.rhymes('sweet');
-console.log(rhymes);
-
 // to analyze a sentence
 let data = RiTa.analyze("The elephant took a bite!");
 console.log(data);
@@ -120,7 +117,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 documentation, see [this interactive notebook](https://observablehq.com/@dhowe/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).
 
 <br>
 
@@ -139,20 +136,10 @@ $ npm run build
 $ npm run test
 
 ```
-If all goes according to plan, you should see a list of successful tests and find the library built in 'dist'
+If all goes well, you should see a list of successful tests and find the library built in 'dist'
 
 <br>
 
-During development it is faster to run tests directly on the source, rather then the built library:
-```sh
-$ npm run test.src
-```
-
-You can also watch the source code and build automatically on any change:
-```sh
-$ npm run watch.src
-```
-
 Please make contributions via [fork-and-pull](https://reflectoring.io/github-fork-and-pull/) - thanks!
 
 ---------------