typo in readme

[MarufZak]

In the docs the following code was provided:

const latinWord = transliterator.toLatin('октябрда');
console.log(latinWord); // -> 'oktabrda' (not 'oktyabrda')

But it logged "oktyabrda" instead.

There was a typo in argument for toLatin invocation, because an exception provided earlier was:

['oktabr', 'октябрь']

[MarufZak]

first i tested it in vite migrated version and thought smth is wrong in build pipeline, but spotted there was a typo :)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.63%. Comparing base (e0b4409) to head (e7fa11f).

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #12   +/-   ##
=======================================
  Coverage   97.63%   97.63%           
=======================================
  Files           6        6           
  Lines         254      254           
  Branches       41       44    +3     
=======================================
  Hits          248      248           
  Misses          6        6           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[diyorbek]

@MarufZak Thank you for noticing. However this doesn't seem like a typo. This seems like an actual bug in the library. It should work just as described in README.md. Nice catch!

The issue is when soft-sign ended words are added suffixes, in cyrillic-uzbek, soft-sign must be dropped. The library seems to be unable to reverse that. Because library doesn't check if the word is a combination of a soft-sign ended word and a suffix.

This should have been one of the test cases but somehow I missed it. Could you open another issue for the bug itself? I am closing this one.