Skip to content

Commit ca62454

Browse files
committed
rewrite intro and install process
1 parent b62854a commit ca62454

File tree

1 file changed

+13
-17
lines changed

1 file changed

+13
-17
lines changed

README.md

+13-17
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
1-
# laravel lib for eloquentize.com service
1+
# laravel lib for alpha.eloquentize.com service
22

33
[![Latest Version on Packagist](https://img.shields.io/packagist/v/eloquentize/laravel-eloquentize-client.svg?style=flat-square)](https://packagist.org/packages/eloquentize/laravel-eloquentize-client)
44
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/eloquentize/laravel-eloquentize-client/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/eloquentize/laravel-eloquentize-client/actions?query=workflow%3Arun-tests+branch%3Amain)
55
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/eloquentize/laravel-eloquentize-client/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/eloquentize/laravel-eloquentize-client/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
66
[![Total Downloads](https://img.shields.io/packagist/dt/eloquentize/laravel-eloquentize-client.svg?style=flat-square)](https://packagist.org/packages/eloquentize/laravel-eloquentize-client)
77

8-
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
8+
Eloquentize provides a full-featured monitoring toolkit for Laravel applications, designed for effortless integration. By incorporating a straightforward library, leveraging a smooth API, and offering a tailor-made dashboard, it simplifies the visualization of daily project metrics. This solution facilitates the efficient tracking and aggregation of model event metrics, streamlining project management and enriching insights, all without the need for extra coding.
99

10-
## Support us
11-
12-
[<img src="https://alpha.eloquentize.com/images/eloquentize-logo-tr.svg" width="419px" />](https://alpha.eloquentize.com/docs)
10+
[<img src="https://alpha.eloquentize.com/images/eloquentize-logo-tr.svg" width="128px" />](https://alpha.eloquentize.com/docs)
1311

12+
# Getting start
1413

1514
## Installation
1615

@@ -28,36 +27,33 @@ php artisan vendor:publish --tag="laravel-eloquentize-client-config"
2827

2928
## Usage
3029

31-
# Getting start
32-
33-
Eloquentize offers a comprehensive monitoring solution for Laravel applications by providing a simple library integration, seamless API usage, and a customizable dashboard to visualize daily projects metrics. It enables efficient tracking and aggregation of model event metrics without additional coding, enhancing project management and insight.
34-
3530
### Requirements
3631

37-
At this point you need a laravel project, even if his version his very old ( 5.6 with php 7.4 is ok, mmm not really ok, because you might not use that anymore, but eloquentize will works on that. )
32+
To get started, you'll require a Laravel project, regardless of its version; even older versions like 5.6 running on PHP 7.4 are compatible, although such setups are less common now. However, Eloquentize is designed to work seamlessly even on these versions.
3833

39-
Having access to the shell might be a good thing to have, but it’s not mandatory, thanks to laravel scheduler. So you need to have a cron job activated on your server, if you use Laravel Forge just activate Laravel scheduler option.
34+
Shell access is beneficial but not essential, thanks to Laravel's scheduler. Therefore, ensuring a cron job is set up on your server is necessary. If you're using Laravel Forge, simply enable the Laravel scheduler option.
4035

41-
You need table with timestamps, this is the point.
36+
Lastly, your database tables must include timestamps for Eloquentize to function correctly.
4237

4338
### Installation
4439

45-
The eloquentize library will be available soon on composer, as soon as the library will be available i assume you can do a composer require eloquentize/client
46-
4740
To set up Eloquentize, start by installing it through Composer with the following command:
4841

4942
```bash
5043
composer require eloquentize/laravel-eloquentize-client
5144
```
5245

53-
This should be done as soon as it becomes available. After installation, proceed to app.eloquentize.com to create your account and generate an API key. This key should then be added to your **`.env`** file in the following manner to complete the configuration process:
46+
for php 7.4 please use
47+
```bash
48+
composer require eloquentize/laravel-eloquentize-client dev-php7.4
49+
```
50+
51+
After installation, proceed to [alpha](https://alpha.eloquentize.com) to create your account and generate an API key. This key should then be added to your **`.env`** file in the following manner to complete the configuration process:
5452

5553
```makefile
5654
ELOQUENTIZE_API_TOKEN=your_api_key_here
5755
```
5856

59-
Eloquentize simplifies the integration into your Laravel projects by connecting through a library, utilizing an API for operations, and providing a dashboard for metrics visualization. This enables tracking of model events such as creation, update, and deletion efficiently without additional coding.
60-
6157
**Usage** involves executing artisan commands like the one below to gather daily metrics:
6258

6359
```bash

0 commit comments

Comments
 (0)