Merge pull request #17 from worksome/feature/changes

chore: remove CHANGELOG and clean up README

README.md

@@ -1,35 +1,19 @@
-# Simple CV and Resume parsing for Laravel applications.
+# Ceevee
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/worksome/ceevee.svg?style=flat-square)](https://packagist.org/packages/worksome/ceevee)
-[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/worksome/ceevee/run-tests?label=tests)](https://github.com/worksome/ceevee/actions?query=workflow%3Arun-tests+branch%3Amain)
-[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/worksome/ceevee/Check%20&%20fix%20styling?label=code%20style)](https://github.com/worksome/ceevee/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
+[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/worksome/ceevee/run-tests.yml?label=tests&style=flat-square)](https://github.com/worksome/ceevee/actions?query=workflow%3Arun-tests+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/worksome/ceevee.svg?style=flat-square)](https://packagist.org/packages/worksome/ceevee)
 
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
+Simple CV and Resume parsing for Laravel applications.
 
-## Support us
-
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/ceevee.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/ceevee)
-
-We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
-
-We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
-
-## Installation
+## Install
 
 You can install the package via composer:
 
 ```bash
 composer require worksome/ceevee
 ```
 
-You can publish and run the migrations with:
-
-```bash
-php artisan vendor:publish --tag="ceevee-migrations"
-php artisan migrate
-```
-
 You can publish the config file with:
 
 ```bash
@@ -40,22 +24,36 @@ This is the contents of the published config file:
 
 ```php
 return [
-];
-```
 
-Optionally, you can publish the views using
+    'default' => env('CEEVEE_DRIVER', 'null'),
 
-```bash
-php artisan vendor:publish --tag="ceevee-views"
+    'services' => [
+
+        'sovren' => [
+            'account_id' => env('SOVREN_ACCOUNT_ID'),
+            'service_key' => env('SOVREN_SERVICE_KEY'),
+            'region' => 'eu',
+            'options' => [],
+        ],
+
+    ],
+
+];
 ```
 
 ## Usage
 
 ```php
-$ceevee = new Worksome\Ceevee();
-echo $ceevee->echoPhrase('Hello, Worksome!');
+$ceevee = new Worksome\Ceevee\Ceevee();
+
+$details = $ceevee->read($file);
+
+// Get the summary
+$details->summary();
 ```
 
+Check out [`Worksome\Ceevee\Support\CVDetail`](src/Support/CVDetail.php) for available options.
+
 ## Testing
 
 ```bash
@@ -64,7 +62,7 @@ composer test
 
 ## Changelog
 
-Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+Please see [GitHub Releases](https://github.com/worksome/ceevee/releases) for more information on what has changed recently.
 
 ## Contributing