Skip to content

Commit

Permalink
readme: update URLs and package name
Browse files Browse the repository at this point in the history
Signed-off-by: Sankarsan Kampa <[email protected]>
  • Loading branch information
iamtraction committed Jan 18, 2021
1 parent 9ed2b8f commit 46e06ba
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# Google Translate API
A [Node.JS](https://nodejs.org) library to consume Google Translate for free.

[![GitHub release](https://img.shields.io/github/release/k3rn31p4nic/google-translate-api.svg?style=flat)](https://github.com/k3rn31p4nic/google-translate-api/releases)
[![Dependencies](https://david-dm.org/k3rn31p4nic/google-translate-api.svg)](https://david-dm.org/k3rn31p4nic/google-translate-api)
[![Known Vulnerabilities](https://snyk.io/test/github/k3rn31p4nic/google-translate-api/badge.svg?targetFile=package.json)](https://snyk.io/test/github/k3rn31p4nic/google-translate-api?targetFile=package.json)
[![license](https://img.shields.io/github/license/k3rn31p4nic/google-translate-api.svg)](LICENSE)
[![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/k3rn31p4nic)
[![GitHub release](https://img.shields.io/github/release/iamtraction/google-translate.svg?style=flat)](https://github.com/iamtraction/google-translate/releases)
[![Dependencies](https://david-dm.org/iamtraction/google-translate.svg)](https://david-dm.org/iamtraction/google-translate)
[![Known Vulnerabilities](https://snyk.io/test/github/iamtraction/google-translate/badge.svg?targetFile=package.json)](https://snyk.io/test/github/iamtraction/google-translate?targetFile=package.json)
[![license](https://img.shields.io/github/license/iamtraction/google-translate.svg)](LICENSE)

### Feature Highlights
* Automatically detect source language
Expand All @@ -22,19 +21,19 @@ A [Node.JS](https://nodejs.org) library to consume Google Translate for free.
## Installation
```bash
# Stable version, from npm repository
npm install --save @k3rn31p4nic/google-translate-api
npm install --save @iamtraction/google-translate

# Latest version, from GitHub repository
npm install --save k3rn31p4nic/google-translate-api
npm install --save iamtraction/google-translate
```

## Usage
```js
// If you've installed from npm, do:
const translate = require('@k3rn31p4nic/google-translate-api');
const translate = require('@iamtraction/google-translate');

// If you've installed from GitHub, do:
const translate = require('google-translate-api');
const translate = require('google-translate');
```

#### Method: `translate(text, options)`
Expand Down Expand Up @@ -101,6 +100,6 @@ translate('Thank you', { from: 'en', to: 'fr' }).then(res => {
```

## Extras
If you liked this project, please give it a ⭐ in [**GitHub**](https://github.com/k3rn31p4nic/google-translate-api) and/or [send a thank you note](https://saythanks.io/to/k3rn31p4nic).
If you liked this project, please give it a ⭐ in [**GitHub**](https://github.com/iamtraction/google-translate).

> Credits to [matheuss](https://github.com/matheuss) for writing the original version of this library. I rewrote this, with improvements and without using many external libraries, as his library was not actively developed and had vulnerabilities.

0 comments on commit 46e06ba

Please sign in to comment.