From 4b46ab805a1cf901e67217a26b773892e95bde3d Mon Sep 17 00:00:00 2001
From: BadinanSoft <66379072+badinansoft@users.noreply.github.com>
Date: Fri, 21 Oct 2022 18:58:48 +0300
Subject: [PATCH] finish up readme file
---
README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
1 file changed, 43 insertions(+)
diff --git a/README.md b/README.md
index e5f48f3..dafa241 100644
--- a/README.md
+++ b/README.md
@@ -17,3 +17,46 @@ This [Nova](https://nova.laravel.com) tool lets you:
- Support Menu Items.
- 1 line of code able you to add a tooltip
+
+## Screenshot
+
+![](https://raw.githubusercontent.com/badinansoft/nova-tooltip/master/docs/tooltip-menu.png)
+
+
+## Installation
+
+You can install the nova tool in to a Laravel app that uses [Nova](https://nova.laravel.com) via composer:
+
+```bash
+ composer require badinansoft/nova-tooltip
+```
+
+## Usage
+
+ - ### Field
+
+Just need add this method to field ``` tooltip() ```
+```php
+ Text::make(__('Domain'), 'domain')
+ ->tooltip(__('Domain For Company
ex: https://badinanshipping.com'))
+```
+
+ - ### Menu Item
+
+Just need add this method to menu item ``` tooltip() ```
+```php
+ MenuItem::resource(ArrivedToTurkishOfficeOrder::class)
+ ->tooltip(__('Arrived Orders
That mean the orders that
arrived to turkish office'))
+ ->name(__('AO')),
+```
+
+
+## Credits
+
+- [Shahab Zebari](https://github.com/shahabzebare)
+- [All Contributors](../../contributors)
+
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.