articulate-nlg
Advanced tools
articulate-nlg - npm Package Compare versions
Comparing version 1.0.2 to 1.0.3
| { | ||
| "name": "articulate-nlg", | ||
| "version": "1.0.2", | ||
| "version": "1.0.3", | ||
| "description": "A natural language generator (NLG) that articulates concepts as words, phrases, and sentences.", | ||
@@ -5,0 +5,0 @@ "main": "./dist/index.js", |
@@ -7,2 +7,30 @@ # Articulate NLG | ||
| ## Table Of Contents | ||
| - [Articulate NLG](#articulate-nlg) | ||
| - [Table Of Contents](#table-of-contents) | ||
| - [Installation](#installation) | ||
| - [Usage](#usage) | ||
| - [Quick Start](#quick-start) | ||
| - [Ready-To-Use Personas Via npm](#ready-to-use-personas-via-npm) | ||
| - [Contributing](#contributing) | ||
| - [Developing On This Project:](#developing-on-this-project) | ||
| - [Sharing Your Personas:](#sharing-your-personas) | ||
| - [Tutorial](#tutorial) | ||
| - [Overview](#overview) | ||
| - [Personas and Cores](#personas-and-cores) | ||
| - [Resolvers](#resolvers) | ||
| - [`do`](#do) | ||
| - [`weight`](#weight) | ||
| - [Generators](#generators) | ||
| - [Text Generators](#text-generators) | ||
| - [Articulate Generators](#articulate-generators) | ||
| - [Context Generators](#context-generators) | ||
| - [Multiple `do` Items For Resolvers](#multiple-do-items-for-resolvers) | ||
| - [Seeding The Pseudorandom Number Generator (PRNG)](#seeding-the-pseudorandom-number-generator-prng) | ||
| - [Built-in Help Text For Concept Names](#built-in-help-text-for-concept-names) | ||
| - [Miscellaneous](#miscellaneous) | ||
| - [TypeScript Support](#typescript-support) | ||
| - [ISC License](#isc-license) | ||
| ## Installation | ||
@@ -107,3 +135,3 @@ | ||
| # Tutorial | ||
| ## Tutorial | ||
@@ -118,3 +146,3 @@ Read this tutorial if: | ||
| ## Overview | ||
| ### Overview | ||
@@ -139,3 +167,3 @@ > articulate | Γ€r-Λti-kyΙ-ΛlΔt | ||
| ## Personas and Cores | ||
| ### Personas and Cores | ||
@@ -165,3 +193,3 @@ A persona is powered by a core, which contains all the concept definitions and text that will be generated. | ||
| ## Resolvers | ||
| ### Resolvers | ||
@@ -195,3 +223,3 @@ Resolvers can be more complicated than just providing strings. In fact, providing a string (as shown above with "hello", "hi", or "hey") is actually shorthand for creating a resolver, like so: | ||
| ### `do` | ||
| #### `do` | ||
@@ -204,3 +232,3 @@ Each resolver has two properties: The first is `do`, which specifies either a single generator (which creates text, more on that in a second), a list of generators/text, or just some text. | ||
| ### `weight` | ||
| #### `weight` | ||
@@ -242,3 +270,3 @@ The second resolver property is `weight`, which defaults to `1`. The weight determines how likely it is for the persona to use a particular resolver when articulating speech. | ||
| ## Generators | ||
| ### Generators | ||
@@ -249,3 +277,3 @@ Once chosen, a resolver's job is to generate text. To do this, it uses generators. | ||
| ### Text Generators | ||
| #### Text Generators | ||
@@ -262,3 +290,3 @@ We've already seen a text generator, so nothing new here. | ||
| ### Articulate Generators | ||
| #### Articulate Generators | ||
@@ -339,3 +367,3 @@ This is where things get fun! Instead of specifying text, you can reference another concept that exists in the core. | ||
| ### Context Generators | ||
| #### Context Generators | ||
@@ -397,3 +425,3 @@ In the real world, we operate on the context of any given situation. For instance, if we know someone's name, we might use it in a sentence while articulating a thought. | ||
| ### Multiple `do` Items For Resolvers | ||
| #### Multiple `do` Items For Resolvers | ||
@@ -406,3 +434,3 @@ When specifying a resolver's `do`, you can either specify a string, a generator, or you can specify a list of generators/strings. | ||
| ## Seeding The Pseudorandom Number Generator (PRNG) | ||
| ### Seeding The Pseudorandom Number Generator (PRNG) | ||
@@ -451,3 +479,3 @@ If you'd like more control over the randomized resolver selection process, you can specify a seed for the pseurdorandom number generator used under the hood. | ||
| ## Built-in Help Text For Concept Names | ||
| ### Built-in Help Text For Concept Names | ||
@@ -488,3 +516,3 @@ You can call `articulate("--help")` or `articulateHelp()` to generate some helpful text containing all concept names. | ||
| ## Miscellaneous | ||
| ### Miscellaneous | ||
@@ -491,0 +519,0 @@ For your convenience/flexibility: |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by2.97%
41658
- Number of lines in readme file
- increased by5.69%
520