Skip to content
This repository has been archived by the owner on May 28, 2023. It is now read-only.

Commit

Permalink
Merge pull request #13 from findbrok/master
Browse files Browse the repository at this point in the history 
Updated README
  • Loading branch information
@percymamedy
percymamedy authored May 28, 2017
2 parents 9fca300 + fa6a12d commit 2a1ffd9
Showing 1 changed file with 53 additions and 39 deletions.
92 changes: 53 additions & 39 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,33 +1,50 @@
# Laravel 5 Personality Insights

[![SensioLabsInsight](https://insight.sensiolabs.com/projects/06dd30e0-4183-4d4f-9cf0-d5045624fccf/big.png)](https://insight.sensiolabs.com/projects/06dd30e0-4183-4d4f-9cf0-d5045624fccf)

[![StyleCI](https://styleci.io/repos/59461266/shield?style=flat)](https://styleci.io/repos/59461266)
[![Build Status](https://travis-ci.org/findbrok/laravel-personality-insights.svg?branch=master)](https://travis-ci.org/findbrok/laravel-personality-insights)
[![Latest Stable Version](https://poser.pugx.org/findbrok/laravel-personality-insights/v/stable)](https://packagist.org/packages/findbrok/laravel-personality-insights)
[![Total Downloads](https://poser.pugx.org/findbrok/laravel-personality-insights/downloads)](https://packagist.org/packages/findbrok/laravel-personality-insights)
[![Latest Unstable Version](https://poser.pugx.org/findbrok/laravel-personality-insights/v/unstable)](https://packagist.org/packages/findbrok/laravel-personality-insights)
[![License](https://poser.pugx.org/findbrok/laravel-personality-insights/license)](https://packagist.org/packages/findbrok/laravel-personality-insights)

A simple Laravel 5 wrapper around [IBM Watson Personality Insights API](http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/personality-insights.html)

## How it works

Personality Insights extracts and analyzes a spectrum of personality attributes to help discover actionable insights about people and entities, and in turn guides end users to highly personalized interactions. The service outputs personality characteristics that are divided into three dimensions: the Big 5, Values, and Needs. While some services are contextually specific depending on the domain model and content, Personality Insights only requires a minimum of 3500+ words of any text.

## Intended Use

The Personality Insights service lends itself to an almost limitless number of potential applications. Businesses can use the detailed personality portraits of individual customers for finer-grained customer segmentation and better-quality lead generation. This data enables them to design marketing, provide product recommendations, and deliver customer care that is more personal and relevant. Personality Insights can also be used to help recruiters or university admissions match candidates to companies or universities.

## Installation

Install the package through composer

```
composer require findbrok/laravel-personality-insights
<p align="center">
<img src="https://raw.githubusercontent.com/findbrok/art-work/master/packages/laravel-personality-insights/laravel-personality-insights.png">
</p>
<h2 align="center">
Laravel Personality Insights
</h2>

<p align="center">
<a href="https://packagist.org/packages/findbrok/laravel-personality-insights"><img src="https://poser.pugx.org/findbrok/laravel-personality-insights/v/stable" alt="Latest Stable Version"></a>
<a href="https://packagist.org/packages/findbrok/laravel-personality-insights"><img src="https://poser.pugx.org/findbrok/laravel-personality-insights/v/unstable" alt="Latest Unstable Version"></a>
<a href="https://travis-ci.org/findbrok/laravel-personality-insights"><img src="https://travis-ci.org/findbrok/laravel-personality-insights.svg?branch=1.1" alt="Build Status"></a>
<a href="https://styleci.io/repos/59461266"><img src="https://styleci.io/repos/59461266/shield?branch=1.1" alt="StyleCI"></a>
<a href="https://packagist.org/packages/findbrok/laravel-personality-insights"><img src="https://poser.pugx.org/findbrok/laravel-personality-insights/license" alt="License"></a>
<a href="https://packagist.org/packages/findbrok/laravel-personality-insights"><img src="https://poser.pugx.org/findbrok/laravel-personality-insights/downloads" alt="Total Downloads"></a>
<a href="https://insight.sensiolabs.com/projects/06dd30e0-4183-4d4f-9cf0-d5045624fccf" alt="medal"><img src="https://insight.sensiolabs.com/projects/06dd30e0-4183-4d4f-9cf0-d5045624fccf/mini.png"></a>
</p>

## Introduction
Laravel Personality Insights, provides a simple and easy to use wrapper
around [IBM Watson Personality Insights API](http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/personality-insights.html)

## License
Laravel Personality Insights is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)

### How it works
Personality Insights extracts and analyzes a spectrum of personality attributes to help discover actionable insights about
people and entities, and in turn guides end users to highly personalized interactions. The service outputs personality
characteristics that are divided into three dimensions: the Big 5, Values, and Needs. While some services are
contextually specific depending on the domain model and content, Personality Insights only requires a
minimum of 3500+ words of any text.

### Intended Use
The Personality Insights service lends itself to an almost limitless number of potential applications. Businesses
can use the detailed personality portraits of individual customers for finer-grained customer segmentation and
better-quality lead generation. This data enables them to design marketing, provide product recommendations,
and deliver customer care that is more personal and relevant. Personality Insights can also be used to
help recruiters or university admissions match candidates to companies or universities.

### Installation
Install the package through composer:

```bash
$ composer require findbrok/laravel-personality-insights
```

Add the Service Provider to your providers array in ```config/app.php```, see [Registering Providers](https://laravel.com/docs/5.2/providers#registering-providers)
Add the Service Provider to your providers array in ```config/app.php```,
see [Registering Providers](https://laravel.com/docs/master/providers#registering-providers)

```php
'providers' => [
Expand All @@ -37,22 +54,19 @@ Add the Service Provider to your providers array in ```config/app.php```, see [R
],
```

## Configuration

### Configuration
Once installed you can now publish your config file and set your correct configuration for using the package.

```bash
$ php artisan vendor:publish --provider="FindBrok\PersonalityInsights\InsightsServiceProvider" --tag="config"
```
php artisan vendor:publish --provider="FindBrok\PersonalityInsights\InsightsServiceProvider" --tag="config"
```

This will create a file ```config/personality-insights.php``` , for information on how to set values present in this file see [Configuration Before Usage](https://github.com/findbrok/laravel-personality-insights/wiki/Configuration-Before-Usage)

## Usage

Read the [docs](https://github.com/findbrok/laravel-personality-insights/wiki)

## Credits
This will create a file ```config/personality-insights.php``` , for information on how to set values present in this file see [Configuration Before Usage](https://github.com/findbrok/laravel-personality-insights/wiki/Configuration-Before-Usage-(1.1))

### Credits
Big Thanks to all developers who worked hard to create something amazing!

### Creator
[![Percy Mamedy](https://img.shields.io/badge/Author-Percy%20Mamedy-orange.svg)](https://twitter.com/PercyMamedy)

Twitter: [@PercyMamedy](https://twitter.com/PercyMamedy)
Expand Down

0 comments on commit 2a1ffd9

Please sign in to comment.