Skip to content

Commit 8d13ef6

Browse files
authored
Update README.md: Added Screenshot (#21)
* Updated the installation section * Added a Screenshot
2 parents ffc3b9b + 3462740 commit 8d13ef6

File tree

1 file changed

+10
-17
lines changed

1 file changed

+10
-17
lines changed

README.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@
88

99

1010

11-
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
11+
This package allows you to incorporate comments and replies in your Filament forms, infolists, pages, widgets etc, or even simply in your livewire components. Comment replies can be nested as deep as you want, using the Nested Set data structure. Additionally, the package comes with a Reactions feature to enable your users to react to any of your models (e.g comments or posts) with selected emoji reactions.
12+
13+
![image](https://github.com/user-attachments/assets/e4ff32b3-0eb9-4ad4-8edb-de91b1940e13)
14+
1215

1316
## Installation
1417

@@ -25,30 +28,20 @@ php artisan vendor:publish --tag="nested-comments-migrations"
2528
php artisan migrate
2629
```
2730

28-
You can publish the config file with:
29-
30-
```bash
31-
php artisan vendor:publish --tag="nested-comments-config"
32-
```
33-
34-
Optionally, you can publish the views using
31+
Run the installation command and follow the prompts:
3532

3633
```bash
37-
php artisan vendor:publish --tag="nested-comments-views"
34+
php artisan nested-comments:install
3835
```
3936

40-
This is the contents of the published config file:
37+
Adjust the configuration file as necessary, then run migrations.
4138

42-
```php
43-
return [
44-
];
45-
```
39+
`That's it! You are now ready to add nested comments
4640

4741
## Usage
48-
42+
**WIP**
4943
```php
50-
$nestedComments = new Coolsam\NestedComments();
51-
echo $nestedComments->echoPhrase('Hello, Coolsam!');
44+
5245
```
5346

5447
## Testing

0 commit comments

Comments
 (0)