Skip to content

Commit

Permalink
fixed README
Browse files Browse the repository at this point in the history
  • Loading branch information
nanek committed Nov 12, 2011
1 parent 6dd3cfb commit aff1138
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 31 deletions.
55 changes: 26 additions & 29 deletions README.md
@@ -1,26 +1,27 @@
A wrapper for the Microsoft Translator API
http://msdn.microsoft.com/en-us/library/dd576287.aspx

Methods
* addTranslation (not implemented)
* addTranslationArray (not implemented)
* breakSentences (not working)
* detect
* detectArray
* getAppIdToken (not implemented) This is a legacy, replaced by
Access Token
* getLanguageNames
* getLanguagesForSpeak
* getLanguagesForTranslate
* getTranslations
* getTranslationsArray
* speak
* translate
* translateArray

Installation
------------
npm install mstranslator
# Microsoft Translator API module for node.js
[Microsoft Translator Documentation](http://msdn.microsoft.com/en-us/library/dd576287.aspx)

## Methods
[Microsoft Translator API
Reference](http://msdn.microsoft.com/en-us/library/ff512404.aspx)
* addTranslation (not implemented)
* addTranslationArray (not implemented)
* breakSentences (not working)
* detect
* detectArray
* getAppIdToken (not implemented) This is a legacy, replaced by
Access Token
* getLanguageNames
* getLanguagesForSpeak
* getLanguagesForTranslate
* getTranslations
* getTranslationsArray
* speak
* translate
* translateArray

## Installation
$ npm install mstranslator

You will also need to register to get an client_id and client_secret to
create access tokens. Details at http://msdn.microsoft.com/en-us/library/hh454950.aspx
Expand All @@ -29,8 +30,7 @@ Specify these values as environment variables.
MSCLIENT_ID=''
MSCLIENT_SECRET=''

Example Usage
-------------
## Example Usage
var tanslator = require('mstranslator')

var params = {
Expand All @@ -45,8 +45,5 @@ Example Usage
});
});


Tests
-----
## Tests
expresso

5 changes: 3 additions & 2 deletions package.json
@@ -1,10 +1,11 @@
{
"author": "Kenan Shifflett <kenan.shifflett@gmail.com>",
"name": "mstranslator",
"description": "Wrapper for the Microsoft Translator API v2",
"description": "Microsoft Translator API module for node.js",
"version": "0.0.1",
"repository": {
"url": ""
"type": "git",
"url": "git://github.com/nanek/mstranslator.git"
},
"main": "mstranslator.js",
"scripts": {
Expand Down

0 comments on commit aff1138

Please sign in to comment.