Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Skytells, Inc authored May 28, 2017
1 parent 16038ac commit 67423ea
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This SDK for recognizing Faces via Skytells Cloud AI APIs, developed for Skytell

## Requirements
- Skytells Framework (Latest Version)
- Skytells API Key
- Skytells API Key - <a href="https://developers.skytells.net/OAuth/">Get Started!</a>
- Apache Server

## Installation
Expand All @@ -19,5 +19,34 @@ $ php skytells install --pkg=https://github.com/Skytells/FacialRecognitionSDK/ra
Or, if you perfer to Clone it.
You can download one of our releases or clones, and put all files directly on ```Application``` folder on Skytells Framework.

## Understanding Package

After Installing the Package on your Skytells Framework, You'll see the following files on your ```Resources``` Folder.

```
[] Controllers
-- FacialRecognition.php
[] Views
[] assets
[] ai
[] js
-- functions.js
-- style.css
-- facialRecognition.ui.php
```

These are the main ```Resources``` files for the package.


## Usage
Now Goto the ```assets/js/functions.js``` file, and put your API Key and you're ready to go!

Now Navigate your browser to the main viewer associated with the controller and the package system is now able to detect your face.

#### Important
You'll need to train each face before recognizing.
See : <a href="https://developers.skytells.net/ai/facerecognition/#train-an-image">Training Faces</a>



0 comments on commit 67423ea

Please sign in to comment.