transliteration
Advanced tools
Comparing version 0.1.0 to 0.1.1
{ | ||
"name": "transliteration", | ||
"version": "0.0.7", | ||
"version": "0.1.1", | ||
"homepage": "https://github.com/andyhu/node-transliteration", | ||
@@ -8,3 +8,3 @@ "authors": [ | ||
], | ||
"description": "Transliterate unicode characters into latin characters. Supports all common unicode characters including CJK.", | ||
"description": "Transliteration module for node.js. Transliterates special unicode characters into corresponding ascii code so it can be safely used as URL slag or filename", | ||
"main": "transliteration.js", | ||
@@ -11,0 +11,0 @@ "keywords": [ |
{ | ||
"name": "transliteration", | ||
"version": "0.1.0", | ||
"description": "Transliteration module for node.js. Transliterate unicode characters into latin characters. Supports all common unicode characters including CJK.", | ||
"version": "0.1.1", | ||
"description": "Transliteration module for node.js. Transliterates special unicode characters into corresponding ascii code so it can be safely used as URL slag or filename", | ||
"main": "lib/transliteration.js", | ||
@@ -6,0 +6,0 @@ "scripts": { |
# Transliteration | ||
Transliteration module for node.js. It can be used to transliterate unicode text into corresponding ascii characters, with support of nearly every commong languages including CJK (Chinese, Japanese and Korean). | ||
Transliteration module for node.js. Can be used to transliterate unicode text into corresponding ascii characters, with support of nearly every common languages including CJK (Chinese, Japanese and Korean). | ||
@@ -15,3 +15,3 @@ ## Install | ||
Transliterate `str`. Characters which this module cannot recognise will be converted to the `unknown` parameter, defaults to `?`. | ||
Transliterate the string `str`. Characters which this module doesn't recognise will be converted to the character in the `unknown` parameter, defaults to `?`. | ||
@@ -28,4 +28,5 @@ __Example__ | ||
Convert unicode string to slugs. It can be savely used in URL or file name. | ||
You can provide an `options` parameter in the form of | ||
Converts unicode string to slugs. So it can be safely used in URL or file name. | ||
__Options:__ | ||
``` | ||
@@ -39,3 +40,3 @@ { | ||
__Example__ | ||
__Example:__ | ||
```javascript | ||
@@ -48,7 +49,9 @@ var slugify = require('transliteration').slugify; | ||
### Client side usage | ||
Transliteration module can run in browser as well. You can download it using bower: | ||
Transliteration module can be run in the browser as well. | ||
Donload the library with bower: | ||
``` | ||
bower install transliteration | ||
``` | ||
It can be loaded as AMD / CommonJS component or global variable. | ||
It supports AMD / CommonJS standard or just to be loaded as a global variable. | ||
@@ -61,3 +64,3 @@ When use in the browser, by default it will create global variables under `window` object: | ||
``` | ||
If you don't like the default name or the variable names conflict with other libraries, you can call noConfilict() method before loading other libraries, then both `window.TR` and `window.Transliteration` will be deleted from windows object: | ||
If you don't like the default variable names or they conflict with other libraries, you can call noConfilict() method before loading other libraries, then both `window.TR` and `window.Transliteration` will be deleted from windows object and Transliteration function will be returned: | ||
```javascript | ||
@@ -69,2 +72,2 @@ var trans = Transliteration.noConflict(); | ||
Please check example.html for a quick demo. | ||
For detailed usage, please check example.html. |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
926867
68