Skip to content

Commit 5170f3f

Browse files
committed
Readme
2 parents 1ad9fd9 + 808c0ec commit 5170f3f

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Detect-File-Encoding-and-Language
22
![npm](https://img.shields.io/npm/dw/detect-file-encoding-and-language)
33
![npm](https://img.shields.io/npm/v/detect-file-encoding-and-language)
4-
![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/detect-file-encoding-and-language)
54
![npm bundle size](https://img.shields.io/bundlephobia/min/detect-file-encoding-and-language)
65

76
[![NPM stats](https://nodei.co/npm/detect-file-encoding-and-language.svg?downloadRank=true&downloads=true)](https://www.npmjs.org/package/detect-file-encoding-and-language)
@@ -49,6 +48,8 @@ $ npm install detect-file-encoding-and-language
4948

5049
```
5150

51+
> Note: This should work fine with frameworks such as React but if you're using pure vanilla Javascript make sure to use a bundler such as Browserify!
52+
5253
```js
5354
// app.js
5455

@@ -84,7 +85,7 @@ $ npm install -g detect-file-encoding-and-language
8485
```
8586

8687
### In the terminal
87-
Use "dfeal" to execute detect-file-encoding-and-language from the command line!
88+
Use the command `dfeal` to retrieve the encoding and language of your file:
8889

8990
```bash
9091
$ dfeal "/home/user name/Documents/subtitle file.srt"
@@ -157,7 +158,7 @@ $ dfeal /home/user\ name/Documents/subtitle\ file.srt
157158
* TIS-620
158159

159160
## Confidence Score
160-
The confidence score ranges from 0 to 1. It is based on the amount of matches that were found for a particular language and the frequency of those matches. If you want to learn more about how exactly it works check out the [Wiki entry](https://github.com/gignupg/Detect-File-Encoding-and-Language/wiki)!
161+
The confidence score ranges from 0 to 1. It is based on the amount of matches that were found for a particular language and the frequency of those matches. If you want to learn more about how it all works, check out the [Wiki entry](https://github.com/gignupg/Detect-File-Encoding-and-Language/wiki)!
161162

162163
## Known Issues
163164
* Unable to detect Shift-JIS encoded Japanese text files when using Node.js. Solutions are welcome!

0 commit comments

Comments
 (0)