Skip to content

Commit e74aed8

Browse files
committed
update readme
1 parent 5414896 commit e74aed8

File tree

1 file changed

+26
-23
lines changed

1 file changed

+26
-23
lines changed

README.md

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,7 @@ $user->getDeniedFriendships($perPage = 20, $fields = ['id','name']);
271271
$user->getBlockedFriendships();
272272
$user->getBlockedFriendships($perPage = 20, $fields = ['id','name']);
273273
```
274+
274275
#### Get a list of blocked Friendships by current user
275276

276277
```php
@@ -460,6 +461,8 @@ $user->toggleFollow($targets);
460461
$user->followings()->get(); // App\User:class
461462
$user->followings(App\Post::class)->get();
462463
$user->isFollowing($target);
464+
$object->followingCount(); // or as attribute $object->following_count
465+
$object->followingCountReadable(); // return readable number with precision, i.e: 5.2K
463466
```
464467

465468
#### `\Multicaret\Acquaintances\Traits\CanBeFollowed`
@@ -718,29 +721,29 @@ $relations = InteractionRelation::popular(App\Post::class)->paginate(15);
718721

719722
This is the list of the events fired by default for each action:
720723

721-
|Event name |Fired |
722-
|--------------------------- |-----------------------------------------------|
723-
|acq.friendships.sent |When a friend request is sent |
724-
|acq.friendships.accepted |When a friend request is accepted |
725-
|acq.friendships.denied |When a friend request is denied |
726-
|acq.friendships.blocked |When a friend is blocked |
727-
|acq.friendships.unblocked |When a friend is unblocked |
728-
|acq.friendships.cancelled |When a friendship is cancelled |
729-
|acq.ratings.rate |When a an item or items get Rated |
730-
|acq.ratings.unrate |When a an item or items get unRated |
731-
|acq.vote.up |When a an item or items get upvoted |
732-
|acq.vote.down |When a an item or items get downvoted |
733-
|acq.vote.cancel |When a an item or items get vote cancellation |
734-
|acq.likes.like |When a an item or items get liked |
735-
|acq.likes.unlike |When a an item or items get unliked |
736-
|acq.followships.follow |When a an item or items get followed |
737-
|acq.followships.unfollow |When a an item or items get unfollowed |
738-
|acq.favorites.favorite |When a an item or items get favored |
739-
|acq.favorites.unfavorite |When a an item or items get unfavored |
740-
|acq.subscriptions.subscribe |When a an item or items get subscribed |
741-
|acq.subscriptions.unsubscribe |When a an item or items get unsubscribed |
742-
|acq.views.view |When a an item or items get viewed |
743-
|acq.views.unview |When a an item or items get unviewed |
724+
| Event name | Fired |
725+
|-------------------------------|-----------------------------------------------|
726+
| acq.friendships.sent | When a friend request is sent |
727+
| acq.friendships.accepted | When a friend request is accepted |
728+
| acq.friendships.denied | When a friend request is denied |
729+
| acq.friendships.blocked | When a friend is blocked |
730+
| acq.friendships.unblocked | When a friend is unblocked |
731+
| acq.friendships.cancelled | When a friendship is cancelled |
732+
| acq.ratings.rate | When a an item or items get Rated |
733+
| acq.ratings.unrate | When a an item or items get unRated |
734+
| acq.vote.up | When a an item or items get upvoted |
735+
| acq.vote.down | When a an item or items get downvoted |
736+
| acq.vote.cancel | When a an item or items get vote cancellation |
737+
| acq.likes.like | When a an item or items get liked |
738+
| acq.likes.unlike | When a an item or items get unliked |
739+
| acq.followships.follow | When a an item or items get followed |
740+
| acq.followships.unfollow | When a an item or items get unfollowed |
741+
| acq.favorites.favorite | When a an item or items get favored |
742+
| acq.favorites.unfavorite | When a an item or items get unfavored |
743+
| acq.subscriptions.subscribe | When a an item or items get subscribed |
744+
| acq.subscriptions.unsubscribe | When a an item or items get unsubscribed |
745+
| acq.views.view | When a an item or items get viewed |
746+
| acq.views.unview | When a an item or items get unviewed |
744747

745748
### Contributing
746749

0 commit comments

Comments
 (0)