From 9ead0c6a94389fe68d606071f18000ee6cc6b440 Mon Sep 17 00:00:00 2001 From: "M. Arman Uz Zuha" <38503380+armandsl@users.noreply.github.com> Date: Sun, 2 Sep 2018 11:57:45 +0600 Subject: [PATCH] Update README.md --- README.md | 58 +++++++++++++++++++++++++++---------------------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 857c96a..61edb13 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Admin option will let you add a default usernamme and repository so you don't ha ``` Argument | Example | Description --- | --- | --- -username | `[github-profile username="seinoxygen"]` | Displays the profile box for the user seinoxygen. +username | `[github-profile username="armandsl"]` | Displays the profile box for the user seinoxygen. #### Repository clone urls ```html @@ -27,8 +27,8 @@ username | `[github-profile username="seinoxygen"]` | Displays the profile box f ``` Argument | Example | Description --- | --- | --- -username | `[github-clone username="seinoxygen"]` | Show ssh & https url. -limit | `[github-clone username="seinoxygen" repository="wp-github"]` | From a selected repo. +username | `[github-clone username="armandsl"]` | Show ssh & https url. +limit | `[github-clone username="armandsl" repository="wp-github"]` | From a selected repo. #### Repositories ```html @@ -36,8 +36,8 @@ limit | `[github-clone username="seinoxygen" repository="wp-github"]` | From a s ``` Argument | Example | Description --- | --- | --- -username | `[github-repos username="seinoxygen"]` | Lists up to 5 repositories from the user seinoxygen. -limit | `[github-repos username="seinoxygen" limit="10"]` | Lists up to 10 repositories from the user seinoxygen. +username | `[github-repos username="armandsl"]` | Lists up to 5 repositories from the user armandsl. +limit | `[github-repos username="armandsl" limit="10"]` | Lists up to 10 repositories from the user armandsl. #### Commits ```html @@ -45,10 +45,10 @@ limit | `[github-repos username="seinoxygen" limit="10"]` | Lists up to 10 repos ``` Argument | Example | Description --- | --- | --- -username | `[github-commits username="seinoxygen"]` | main username -repository | `[github-commits username="seinoxygen" repository="wp-github"]` | Lists up to 5 commits from the repository wp-github. -limit | `[github-commits username="seinoxygen" repository="wp-github" limit="10"]` | Lists up to 10 commits. -xtended | [github-commits username="seinoxygen" repository="wp-github" limit="30" xtended='{"Date de commit": "commit:committer:date","Email committer": "commit:committer:email","Url de commit": "url"}'] | allow to get custom data, Caution XPERIMENTAL! json format, rely on github api endpoints +username | `[github-commits username="armandsl"]` | main username +repository | `[github-commits username="armandsl" repository="wp-github"]` | Lists up to 5 commits from the repository wp-github. +limit | `[github-commits username="armandsl" repository="wp-github" limit="10"]` | Lists up to 10 commits. +xtended | [github-commits username="armandsl" repository="wp-github" limit="30" xtended='{"Date de commit": "commit:committer:date","Email committer": "commit:committer:email","Url de commit": "url"}'] | allow to get custom data, Caution XPERIMENTAL! json format, rely on github api endpoints For correct listing username and repository **_are_** required. @@ -58,9 +58,9 @@ For correct listing username and repository **_are_** required. ``` Argument | Example | Description --- | --- | --- -username | `[github-issues username="seinoxygen"]` | main username -repository | `[github-issues username="seinoxygen" repository="wp-github"]` | Lists up to 5 issues from the repository wp-github. -limit | `[github-issues username="seinoxygen" repository="wp-github" limit="10"]` | Lists up to 10 issues from the repository wp-github. +username | `[github-issues username="armandsl"]` | main username +repository | `[github-issues username="armandsl" repository="wp-github"]` | Lists up to 5 issues from the repository wp-github. +limit | `[github-issues username="armandsl" repository="wp-github" limit="10"]` | Lists up to 10 issues from the repository wp-github. #### Issue @@ -69,9 +69,9 @@ limit | `[github-issues username="seinoxygen" repository="wp-github" limit="10"] ``` Argument | Example | Description --- | --- | --- -username | `[github-issue username="seinoxygen"]` | main username -repository | `[github-issue username="seinoxygen" repository="wp-github"]` | selected repo -number | `[github-issue username="seinoxygen" repository="wp-github" number="14"]` | issue number +username | `[github-issue username="armandsl"]` | main username +repository | `[github-issue username="armandsl" repository="wp-github"]` | selected repo +number | `[github-issue username="armandsl" repository="wp-github" number="14"]` | issue number #### Pull request ```html @@ -79,9 +79,9 @@ number | `[github-issue username="seinoxygen" repository="wp-github" number="14" ``` Argument | Example | Description --- | --- | --- -username | `[github-pulls username="seinoxygen"]` | main username -repository | `[github-pulls username="seinoxygen" repository="wp-github"]` | from the repository wp-github. -limit | `[github-pulls username="seinoxygen" repository="wp-github" limit="10"]` | Lists up to 10 pull request from the repository wp-github. +username | `[github-pulls username="armandsl"]` | main username +repository | `[github-pulls username="armandsl" repository="wp-github"]` | from the repository wp-github. +limit | `[github-pulls username="armandsl" repository="wp-github" limit="10"]` | Lists up to 10 pull request from the repository wp-github. #### Gists ```html @@ -89,8 +89,8 @@ limit | `[github-pulls username="seinoxygen" repository="wp-github" limit="10"]` ``` Argument | Example | Description --- | --- | --- -username | `[github-gists username="seinoxygen"]` | Lists up to 5 gists from the user seinoxygen. -limit | `[github-gists username="seinoxygen" limit="10"]` | Lists up to 10 gists from the user seinoxygen. +username | `[github-gists username="armandsl"]` | Lists up to 5 gists from the user armandsl. +limit | `[github-gists username="armandsl" limit="10"]` | Lists up to 10 gists from the user armandsl. #### File content ```html @@ -98,10 +98,10 @@ limit | `[github-gists username="seinoxygen" limit="10"]` | Lists up to 10 gists ``` Argument | Example | Description --- | --- | --- -username | `[github-contents username="seinoxygen"]` |Add username (except if filled in wp BO. -repository | `[github-contents username="seinoxygen" repository="wp-github"]` | pick up a repository from the user seinoxygen. -filepath | `[github-contents username="seinoxygen" repository="wp-github" filepath="wp-github.css"]` | Select a file with full path in the repository. -language | `[github-contents username="seinoxygen" repository="wp-github" filepath="wp-github.css" language="css"]` | Help JsHighlighter if exists, will generate code inside PRE and CODE tags. +username | `[github-contents username="armandsl"]` |Add username (except if filled in wp BO. +repository | `[github-contents username="armandsl" repository="wp-github"]` | pick up a repository from the user armandsl. +filepath | `[github-contents username="armandsl" repository="wp-github" filepath="wp-github.css"]` | Select a file with full path in the repository. +language | `[github-contents username="armandsl" repository="wp-github" filepath="wp-github.css" language="css"]` | Help JsHighlighter if exists, will generate code inside PRE and CODE tags. #### Releases ```html @@ -109,9 +109,9 @@ language | `[github-contents username="seinoxygen" repository="wp-github" filepa ``` Argument | Example | Description --- | --- | --- -username | `[github-releases username="seinoxygen"]` |Add username (except if filled in wp BO. -repository | `[github-releases username="seinoxygen" repository="wp-github"]` | pick up a repository from the user seinoxygen. -limit | `[github-releases username="seinoxygen" repository="wp-github" limit="10"]` | Lists up to 10 releases. +username | `[github-releases username="armandsl"]` |Add username (except if filled in wp BO. +repository | `[github-releases username="armandsl" repository="wp-github"]` | pick up a repository from the user armandsl. +limit | `[github-releases username="armandsl" repository="wp-github" limit="10"]` | Lists up to 10 releases. #### Latest release ```html @@ -119,5 +119,5 @@ limit | `[github-releases username="seinoxygen" repository="wp-github" limit="10 ``` Argument | Example | Description --- | --- | --- - username | `[github-releaseslatest username="seinoxygen"]` |Add username (except if filled in wp BO. - repository | `[github-releaseslatest username="seinoxygen" repository="wp-github"]` | pick up a repository from the user seinoxygen. + username | `[github-releaseslatest username="armandsl"]` |Add username (except if filled in wp BO. + repository | `[github-releaseslatest username="armandsl" repository="wp-github"]` | pick up a repository from the user armandsl.