vietnamese-phonetic-transcript 1.0.0 → 1.0.1

package/README.md

@@ -43,7 +43,7 @@
 
 <!-- Table of Contents -->
 
-# :notebook_with_decorative_cover: Table of Contents
+## :notebook_with_decorative_cover: Table of Contents
 
 - [Getting Started](#toolbox-getting-started)
   - [Prerequisites](#bangbang-prerequisites)
@@ -200,6 +200,31 @@ Hệ thống âm cuối: 6 phụ âm, 2 bán nguyên âm
 | 8   | /-j/   | i (còn lại)                             | cái, ngoái, cưới, cuối              |
 | 9   | /zero/ | không thể hiện                          | bà, bố, mẹ                          |
 
+### Phonetic Transcription Script
+
+To transcribe Vietnamese text to its phonetic representation, you can use
+function `phoneticTranscriptWord` for individual words or
+`phoneticTranscriptSentence` for entire sentences.
+Here's how to use these functions:
+
+```typescript
+import {
+  phoneticTranscriptSentence,
+  phoneticTranscriptWord,
+} from 'vietnamese-phonetic-transcript'
+// Transcribe a single word
+const word = 'chào'
+const phoneticWord = phoneticTranscriptWord(word)
+console.log(`Phonetic transcription of "${word}": ${phoneticWord}`)
+```
+
+```typescript
+// Transcribe a full sentence
+const sentence = 'Xin chào, bạn có khỏe không?'
+const phoneticSentence = phoneticTranscriptSentence(sentence)
+console.log(`Phonetic transcription of the sentence: ${phoneticSentence}`)
+```
+
 ### Syllable Analysis
 
 This project includes a script to analyze Vietnamese syllables from a text file
@@ -208,7 +233,7 @@ and validate them using phonetic transcription.
 To run the analysis, use the following command:
 
 ```bash
-npx tsx src/syllable_analysis.ts
+npx tsx lib/syllable_analysis.ts
 ```
 
 Result:
@@ -281,7 +306,9 @@ Why Only 1.2% of Theoretical Combinations Exist?
 ## :wave: Contributing
 
 <a href="https://github.com/DuckyMomo20012/vietnamese-phonetic-transcript/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=DuckyMomo20012/vietnamese-phonetic-transcript" />
+  <img
+  src="https://contrib.rocks/image?repo=DuckyMomo20012/vietnamese-phonetic-transcript"
+ alt="contributors" />
 </a>
 
 Contributions are always welcome!