Skip to content

Commit 35de820

Browse files
committed
Update readme
1 parent 5c01ba0 commit 35de820

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
# stringdiff
1+
# [stringdiff-luau](https://pesde.dev/packages/caveful_games/stringdiff)
22
A string similarity metric diffing algorithm invented by splinestein for primitive chat bot use.
33

4+
This is a fork of [splinestein/splinestein-diffing-algorithm](https://github.com/splinestein/splinestein-diffing-algorithm)
5+
6+
Modified for Luau and pesde.
7+
48
* Link to module: https://www.roblox.com/library/12088663460/StringDiff
59
* Open source and can be viewed here: https://github.com/splinestein/splinestein-diffing-algorithm/blob/main/stringdiff.lua
610
* Link to release thread: https://devforum.roblox.com/t/stringdiff-string-similarity-metric-diffing-algorithm/2131245
@@ -9,9 +13,7 @@ A string similarity metric diffing algorithm invented by splinestein for primiti
913

1014
Install a package via `pesde`
1115
```sh
12-
pesde add caveful_games/stringdiff -t luau
13-
14-
pesde install
16+
pesde add caveful_games/stringdiff
1517
```
1618

1719
I've tested this for primitive chat bot use and it's working nicely.
@@ -20,3 +22,6 @@ It is worth mentioning that this will have O(n) complexity if iterating over any
2022
small unless you use better querying techniques on the dataset like FTS.
2123

2224
Hope you enjoy. Feel free to suggest any changes.
25+
26+
## TO-DOs
27+
- [ ] Generate `docs` with markdown from moonwave comments for pesde docs (be likely to be released in 0.2.0)

0 commit comments

Comments
 (0)