diff --git a/profile/README.md b/profile/README.md index d4aa7a4..c729d49 100644 --- a/profile/README.md +++ b/profile/README.md @@ -69,76 +69,6 @@ This means data masking is super fast and happens on a programming level before 2. [Create a Treblle project](https://docs.treblle.com/en/dashboard/projects#creating-a-project). 3. [Setup the SDK](https://docs.treblle.com/integrations/) for your platform. -### Install the SDK - -Install Treblle for Laravel via Composer by running the following command in your terminal: - -```sh -composer require treblle/treblle-laravel -``` - -You can get started with Treblle **directly from your Artisan console**. Just type in the following command in your -terminal: - -```bash -php artisan treblle:start -``` - -The command guides you through a process and allows you to create an account, login to your existing account, create a -new project and get all the `.ENV` keys you need to start using Treblle. - -You can also visit our website [https://app.treblle.com](https://app.treblle.com) and create a FREE account to get your API key and Project ID. Once -you have them, simply add them to your `.ENV` file: - -```shell -TREBLLE_API_KEY=YOUR_API_KEY -TREBLLE_PROJECT_ID=YOUR_PROJECT_ID -``` -## Enabling Treblle on your API - -Your first step should be to register Treblle into your in your middleware aliases in `app/Http/Kernel.php`: - -```php -protected $middlewareAliases = [ - // the rest of your middleware aliases - 'treblle' => \Treblle\Middlewares\TreblleMiddleware::class, -]; -``` - -Open the **routes/api.php** and add the Treblle middleware to either a route group like so: - -```php -Route::middleware(['treblle'])->group(function () { - - // YOUR API ROUTES GO HERE - Route::prefix('samples')->group(function () { - Route::get('{uuid}', [SampleController::class, 'view']); - Route::post('store', [SampleController::class, 'store']); - }); - -}); -``` - -or to an individual route like so: - -```php -Route::group(function () { - Route::prefix('users')->group(function () { - - // IS LOGGED BY TREBLLE - Route::get('{uuid}', [UserController::class, 'view'])->middleware('treblle'); - - // IS NOT LOGGED BY TREBLLE - Route::post('{uuid}/update', [UserController::class, 'update']); - }); -}); -``` - -You're all set. Next time someone makes a request to your API you will see it in real-time on your Treblle dashboard -alongside other features like: auto-generated documentation, error tracking, analytics and API quality scoring. - -> See the [docs](https://docs.treblle.com/en/integrations/laravel) for this SDK to learn more. - ## Available SDKs Treblle provides [open-source SDKs](https://docs.treblle.com/en/integrations) that let you seamlessly integrate Treblle with your REST-based APIs.