diff --git a/README.md b/README.md index 94b3309..0a5340d 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,22 @@ -#arabicString +# arabicString A Javascript library that extends the native `String` object with methods to help when dealing with Arabic strings for _node_ and _the browser_. -##Usage -###node +## Usage +### node ```js require('arabicString') ``` -###browser +### browser ```js ``` -##String#howArabic() +### String.howArabic() The percentage of Arabic letters in the `String`. -### Example +#### Example ```js 'foobar'.howArabic() @@ -27,11 +27,11 @@ The percentage of Arabic letters in the `String`. //=> 1.0 ``` -##String#howNotArabic() +### String.howNotArabic() The percentage of non-Arabic letters in the `String`. -### Example +#### Example ```js 'فوبار'.howNotArabic() @@ -42,11 +42,11 @@ The percentage of non-Arabic letters in the `String`. //=> 1.0 ``` -##String#isArabic(threshold) +### String.isArabic(threshold) Is the `String` Arabic, based on a given `threshold` between `0` and `1`. Defaults to `0.79`. -### Example +#### Example ```js 'فوو'.isArabic() @@ -55,11 +55,11 @@ Is the `String` Arabic, based on a given `threshold` between `0` and `1`. Defaul //=> false ``` -##String#hasArabic() +### String.hasArabic() Does the `String` have _any_ Arabic letter. -### Example +#### Example ```js 'فوو bar'.hasArabic() @@ -68,11 +68,11 @@ Does the `String` have _any_ Arabic letter. //=> false ``` -##String#removeTashkel() +### String.removeTashkel() Will return the `String` without the diacritics. -### Example +#### Example ```js 'مٌحمْد'.removeTashkel()