Merge pull request #24 from aneshodza/feature/prepare-release-1.2.1

Make changes for version 1.2.1

Author: aneshodza

README.md

@@ -13,7 +13,7 @@ It only checks for these two things on the node it's currently on (while being i
 ---
 
 ## Usage
-**Important:** This just goes over creating an automaton using every configuration option. [Here](./tests/integration_tests/README.md) you can find real use-cases.
+**Important:** This just goes over creating an automaton using every configuration option. [Here](./tests/integration_tests/README.md) you can find real use-cases.  
 Creating a pushdown automaton involves following steps:
 1. Creating the automaton instance
 2. Creating all the states
@@ -27,8 +27,8 @@ import { PushdownAutomaton, State, TransitionFunction } from 'pushdown-automaton
 
 /*
  * 1. Instantiate the pushdown automaton with the input word
- * Provide a 2nd parameter to define the initial stack token.
- * Normally that's a dollar sign, but here I define it as %
+ *    Provide a 2nd parameter to define the initial stack token.
+ *    Normally that's a dollar sign, but here I define it as %
  */
 let automaton: PushdownAutomaton;
 automaton = new PushdownAutomaton("test", "%");
@@ -43,10 +43,10 @@ otherState = new State("q1");
 
 /* 
  * 3. Instantiate transitions
- * First parameter is the token to be consumed
- * The second parameter is the state where the transition leads to
- * The third parameter shows the token to be popped off the stack
- * The fourth parameter is an array of things that will be pushed onto the stack
+ *    First parameter is the token to be consumed
+ *    The second parameter is the state where the transition leads to
+ *    The third parameter shows the token to be popped off the stack
+ *    The fourth parameter is an array of things that will be pushed onto the stack
  */
 let transitionFunction: Transition;
 transitionFunction = new Transition("t", otherState, "$", ["c", "d"]);
@@ -75,6 +75,12 @@ const someFunction = (automaton) => {
     // Do some stuff here
 }
 pushdownAutomaton.addOperation(someFunction);
+
+/*
+ * 8. Now you can re-run it. But make sure to add a new word, as
+ *    the old one was consumed by the automaton
+ */ 
+pushdownAutomaton.run("some new word");
 ```
 
 #### Return values of `run()`

docs/CHANGELOG.md

@@ -5,7 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.2.0] - 2024-04-20
+## [1.2.1] - 2024-04-25
+### Fixed
+- Re-runs now work properly.
+
+### Added
+- An optional parameter to `run()`, which sets the `inputWord` before running the automaton.
+- Added integration tests by showing real automatons and their usage.
+
+## [1.2.0] - 2024-04-24
 ### Fixed
 - Properly fix the building CI. There was a confucion between cjs and esm, which has now been resolved.
 - The termination message import (or lack thereof) was messing when using the library.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pushdown-automaton",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "A library that allows you to create a deterministic pushdown automaton",
   "main": "out/index.js",
   "types": "out/index.d.ts",