jean/metamorpov-library
jean
/
metamorpov-library
1
0
Fork 0
Code Issues Pull Requests Activity

Adding usage information to README

This commit is contained in:
Jean Viscogliosi-Pate 2025-08-14 21:05:22 -07:00
parent 39014354e2
commit 366cf11034
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -2,6 +2,22 @@
This library provides the translation logic for the MetamorPOV [browser extension](https://git.viscogliosi-pate.com/jean/metamorpov). It exports a single function to replace specific plaintext markers (such as Y/n, pov/s, and vrb/do/present/) with their English equivalents.
## Usage
After installing the package and including it in your file header, you can call the single function that MetamorPOV exports.
```js
const input = "Pov/s vrb/present/like/ watching birds.";
const options = {
name: "Amelia",
preset: "she",
pov: "third"
};
// "She likes watching birds."
console.log(metamorpov.translate(input, options));
```
## Development
MetamorPOV requires Node packages for evaluating some grammar rules. You'll need [Node](https://nodejs.org/) installed globally. As an alternative, install [Nix](https://nixos.org/) and type `nix develop` with the experimental flakes feature enabled. After that, from the extension's root directory: