git @ Cat's Eye Technologies Lexeduct / 3e8d89c
Some clarificatory updates to the README. Chris Pressey 6 years ago
1 changed file(s) with 27 addition(s) and 1 deletion(s). Raw diff Collapse all Expand all
33 **Lexeduct** is an experimental framework for text-processing pipelines, written
44 in Javascript, usable in both node and in the browser (knock on wood.)
55
6 It is currently at a what is this I don't even stage of development. The
6 It is currently at a *what is this I don't even* stage of development. The
77 framework and usage and everything is subject to change without notice.
8
9 Being a framework, Lexeduct inevitably handles some use cases well, and other
10 use cases poorly. Don't expect too much from it. More details here soon.
11
12 The name "Lexeduct" is in analogy with "aqueduct": conduits for words intead
13 of water.
814
915 Basic Usage
1016 -----------
4046 $ echo 'Hello!' | lexeduct.js upper 'chars= ' insert-chars
4147 H E L L O !
4248
49 Multiple transformers are applied left-to-right.
50
51 $ echo 'Hello!' | lexeduct.js 'chars=a' insert-chars upper
52 HAEALALAOA!A
53
54 $ echo 'Hello!' | lexeduct.js upper 'chars=a' insert-chars
55 HaEaLaLaOa!a
56
4357 Transformers
4458 ------------
4559
6983 `state` is an object whose members may be read or written to store ancillary
7084 state. (Doing so will make it an 'impure' pipeline.)
7185
86 Acknowledgements
87 ----------------
88
89 Lexeduct was partly inspired by, and is partly a product of parallel evolution
90 resembling, [Michael Paulukonis][]'s [TextMunger][]. It is also indebted to
91 various and sundry discussion with him and others on the
92 [GenerativeText Forum][].
93
7294 TODO
7395 ----
7496
7597 * Allow filters to do something at the very end, maybe.
7698 * Allow filters return multiple, or no, strings.
7799 * Many, many other things.
100
101 [Michael Paulukonis]: https://github.com/MichaelPaulukonis/
102 [TextMunger]: https://github.com/MichaelPaulukonis/text-munger
103 [GenerativeText Forum]: https://groups.google.com/forum/#!forum/generativetext