From 9f436729d9e96913517a17eb4b6ad0f2df3c85fc Mon Sep 17 00:00:00 2001 From: Deefaze <6393617+Deefaze@users.noreply.github.com> Date: Tue, 9 Apr 2019 05:53:10 +0200 Subject: [PATCH] Add table of content in Readme.md (#8) * Full readme arrangement --- README.md | 42 ++++++++++++++++++++++++++++++++++++++---- src/.DS_Store | Bin 8196 -> 0 bytes 2 files changed, 38 insertions(+), 4 deletions(-) delete mode 100644 src/.DS_Store diff --git a/README.md b/README.md index 6fb8482..5316a37 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,29 @@ [![Downloads](https://img.shields.io/packagist/dt/musonza/groups.svg?style=flat-square)](https://packagist.org/packages/musonza/groups) [![StyleCI](https://styleci.io/repos/55277679/shield?branch=master)](https://styleci.io/repos/55277679) +# Table of content + +- [Description](#description) +- [Installation](#installation) + + Install with Composer + + Add service provider to App + + Add facade alias to App + + Publish vendor with Artisan + + Tables details + + Make migration with Artisan +- [Usage](#usage) + + [Groups](#groups) + * Create, Delete, Update, Users list, Add member, Join request, Accept join, Decline join, Join request list + + [Posts](#posts) + * Create, Get, Update, Delete, Add to group, Group posts list, User posts list + + [Comments](#comments) + * Add, Get, Update, Delete + + [Reporting](#reporting) + * Report, Remove, Toggle , Count + + [Likes](#likes) + * Like, Unlike, Toggle, Count + + # Description This package allows you to add user groups _(groups, comment, like ...)_ system to your Laravel 5 application. @@ -23,7 +46,7 @@ composer require musonza/groups 3. You can use the facade for shorter code. Add this to `./config/app.php` at the end of `aliases` array : - +> Note : is facultative. ```php 'Groups' => Musonza\Groups\Facades\GroupsFacade::class, ``` @@ -38,9 +61,20 @@ $groups = App::make('Groups'); php artisan vendor:publish ``` -```console -php artisan migrate -``` +> Note : This will publish database migrations in `./database/migrations/`. +``` +create_groups_table // main groups table + id + name + description + short_description + image + url + user_id + private + conversation_id + extra_info + settings # Usage diff --git a/src/.DS_Store b/src/.DS_Store deleted file mode 100644 index 431e8e04d70d001ad17d42fd7792df64253463e1..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 8196 zcmeI1OKjXk7{|XakJjrxGMh)&Y1npA648`2q-khUC}s1aEp60@q zLUadAN*m^(0-*xy72vOr3X^ndABXJf^Lsk)O{Hx&P5wX9Q?}*#&CSbLR9sTJZMzat zckmC3s(1HKxcPox_ouy1J$pgaEW=C(=|RiPr&wi|>-f6mnAugK zV?&l>xcN?Z+A+MbemUNdW%v^*R@Ij^a}?UAJLaI}S!v6*{EJG2e^M+qJKNgUm}oiN zGS`@xZEI_8Otc<3Iyc82Q%_(rskerSbY7BOPAmL^fM_321^Q5tdZyQ&9t$- zT%XjY$Sr8|{VHv=?#doD#mf0S&rSK3>v)4^)+3u@WgZE3I^#OQ_ZZ5!_VlFVrC2nh z+nH%w_stI5?zbK=yq`8=0!ME5eLV_44kC<*KM)_sn`xBZv;L)s@9(1g$SJi?0={Yhl zB10Pvs@i#5Pn$L~A~LM$CRH2CNom-bpz%nnstsq{$w``=7sbY)x&4@?-NWyER`>jK zQ>H_+`igFU+lkwm7SlR6`<99_!lOD2gJxTsJRl!(ZL(PwBDC>TLlbQ?r(g_Bn1YM& z3_J_Z!7H!`Z^L`=5qtq(!q;#GzJX=<34VrO;8*w^{z5=R70WP+npmiV8@c zl=VW6pHOMT*OibAUe}_bjgXA@RNV1DA-TMhgBUHZsH_Ue>{xlcYaZxovII_&7r{}1 z6G7=!a4r$9)q88y_<6$3oLP%`0SvZX!o+*;PsHO)5&ZCKT|HHc2y#V?)o?JbvSNWU z_Y$RXRw|(7RpL`+B?4<+Z9hidZGztFn6^hfp(e%K#6XM{sgJ9)HvJRu76`i!3A!ur zEqn(*z>n}7{7JZ#5^6E5CeY%z4{yK*yb&Am5TVwNx8SXK9DDF20e2@MH$cD*;|Put zawd-B1X`FyA9I+;8GHmE#mDgpe3Afs0bj(I@KwCD2E9`S=%mHVo1vHM&pNj2jFZ2B z?bV@SZEGq}ET^UM^MB9gzyEK|$%nHF6$lmhR}{dK?*8sh8fvrUo1e84blpoAPrTo} tv?7Eu-i5b|<2c!sKMbjy2z<%F&Pz)kO8@x}0b*AU_y2JJ7x-PX+28g->k9w?