Home

Awesome

what-dog Build Status

Get the breed of a dog from an image using Microsoft's what-dog.

<img src="http://imgur.com/B7a15F5.jpg" width="300px">
{
  "isDog": true,
  "breed": "Norfolk Terrier",
  "about": "Spirited, small but sturdy, feisty yet sweet personality"
}

Install

$ npm install --save what-dog

Usage

const whatDog = require('what-dog');

whatDot('http://imgur.com/B7a15F5.jpg');
    .then(doggyData => {
        console.log(doggyData);
    })

//=> {
       isDog: true,
       breed: 'Norfolk Terrier',
       about: 'Spirited, small but sturdy, feisty yet sweet personality'
     }

API

whatDot(imageUrl)

imageUrl

Type: string

Url to the image. Must be on a public server that Microsoft's servers can download to determine the caption.

Returns a promise for the doggy data.

doggy data

{
  isDog: true,
  breed: 'Norfolk Terrier',
  about: 'Spirited, small but sturdy, feisty yet sweet personality'
}

Notes

License

MIT © Dylan Greene