Merge branch 'master' of https://github.com/securenative/securenative-php

Author: AmitBu

README.md

@@ -1,29 +1,41 @@
-# SecureNative PHP
-
-## Requirements
-
-* PHP version >= 7.2
-* Composer
-
-## Installation using composer
-
+<p align="center">
+  <a href="https://www.securenative.com"><img src="https://user-images.githubusercontent.com/45174009/77826512-f023ed80-7120-11ea-80e0-58aacde0a84e.png" alt="SecureNative Logo"/></a>
+</p>
+
+<p align="center">
+  <b>A Cloud-Native Security Monitoring and Protection for Modern Applications</b>
+</p>
+<p align="center">
+  <a href="https://github.com/securenative/securenative-php">
+    <img alt="Github Actions" src="https://github.com/securenative/securenative-php/workflows/CI/badge.svg">
+  </a>
+  <a href="https://codecov.io/gh/securenative/securenative-php">
+    <img src="https://codecov.io/gh/securenative/securenative-php/branch/master/graph/badge.svg" />
+  </a>
+</p>
+<p align="center">
+  <a href="https://docs.securenative.com">Documentation</a> |
+  <a href="https://docs.securenative.com/quick-start">Quick Start</a> |
+  <a href="https://blog.securenative.com">Blog</a> |
+  <a href="">Chat with us on Slack!</a>
+</p>
+<hr/>
+
+
+[SecureNative](https://www.securenative.com/) performs user monitoring by analyzing user interactions with your application and various factors such as network, devices, locations and access patterns to stop and prevent account takeover attacks.
+
+## Install the SDK
+
+When using Composer run the following command:
 ```shell script
 $ composer require securenative/securenative-php
 ```
 
-## Configuration
-
-#### Using package
-```php
-require_once __DIR__ . '/vendor/autoload.php';
-
-use SecureNative\sdk\SecureNative;
-use SecureNative\sdk\SecureNativeOptions;
-use SecureNative\sdk\EventTypes;
-```
+## Initialize the SDK
 
-#### Initializing SDK
+To get your *API KEY*, login to your SecureNative account and go to project settings page:
 
+### Option 1: Initialize via ConfigurationBuilder
 ```php
 $options =  new SecureNativeOptions();
 
@@ -32,19 +44,20 @@ $options->setLogLevel("error");
 
 SecureNative::init("YOUR_API_KEY", $options);
 ```
+### Option 2: Initialize via API Key
 
-| Option | Type | Optional | Default Value | Description |
-| -------| -------| -------| -------| -------------------------------------------------|
-| apiKey | string | false | none | SecureNative api key |
-| apiUrl | string | true | https://api.securenative.com/v1/collector | Default api base address|
-| interval| number | true | 1000 | Default interval for SDK to try to persist events|  
-| maxEvents | number | true | 1000 | Max in-memory events queue| 
-| timeout | number | true | 1500 | API call timeout in ms|
-| autoSend | Boolean | true | true | Should api auto send the events|
-
-## Event tracking
+Initialize using default options.
 
+```php
+SecureNative::init("YOUR_API_KEY");
 ```
+
+## Tracking events
+
+Once the SDK has been initialized, tracking requests sent through the SDK
+instance.
+
+ ```php
 SecureNative::track(array(
     'event' => EventTypes::LOG_IN,
     'context' => SecureNative::contextFromContext(),
@@ -60,26 +73,46 @@ SecureNative::track(array(
         "prop3" => 3
     ]
 ));
+ ```
 
-or
+You can also create request context from request:
 
-$ver = SecureNative::verify(array(
-    'event' => EventTypes::VERIFY,
+```php
+SecureNative::track(array(
+    'event' => EventTypes::LOG_IN,
+    'context' => SecureNativeContext::fromRequest(),
     'userId' => '1234',
-    'context' => SecureNative::contextFromContext()
     'userTraits' => (object)[
         'name' => 'Your Name',
         'email' => 'name@gmail.com'
-    ]
+    ],
+));
+```
+
+## Verify events
+
+**Example**
+
+```php
+$ver = SecureNative::verify(array(
+        'event' => EventTypes::VERIFY,
+        'userId' => '27',
+        'context' => SecureNativeContext::fromRequest(),
+        'userTraits' => (object)[
+            'name' => 'Your Name',
+            'email' => 'name@gmail.com'
+        ]
 ));
 ```
 
-Middleware:
+## Webhook signature verification
+
+Apply our filter to verify the request is from us, for example:
 
 ```php
 $verified = SecureNative::getMiddleware()->verifySignature();
 
 if ($verified) {
     // Request is trusted (coming from SecureNative) 
 }
-```
+ ```