forked from seinoxygen/wp-github
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathreadme.txt
120 lines (85 loc) · 3.64 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
=== WP Github ===
Contributors: seinoxygen,moabi
Donate link: http://www.seinoxygen.com/projects/wp-github
Tags: github, profile, repositories, commits, issues, gists, widget, shortcode
Requires at least: 4.1
Tested up to: 4.6
Stable tag: 1.2
License: MIT License
License URI: http://opensource.org/licenses/MIT
Display users Github public profile, repositories, commits, issues and gists.
== Description ==
WP Github provides three sidebar widgets which can be configured to display public profile, repositories, commits, issues and gists from github in the sidebar. You can have as many widgets as you want configured to display different repositories.
Currently the plugin can list:
* Profile
* Repositories
* Commits
* Issues
* Gists
* Pull request
* Single Issue
* Embed File content (with highlighter)
### Using CSS
The plugin uses a basic unordered lists to enumerate. In the future will be implemented a simple template system to increase the customization.
You can apply a customized style to the plugin simply uploading a file called `custom.css` in the plugin folder. It will allow you to upgrade the plugin without loss your custom style.
### Caching
The plugin caches all the data retrieved from Github every 10 minutes to avoid exceed the limit of api calls.
Since version 1.1 you can clear the cache from the plugin settings page located in the Wordpress settings menu.
Since version 1.2.6 you can add your github credentials
### Support
If you have found a bug/issue or have a feature request please report here: https://github.com/seinoxygen/wp-github/issues
== Installation ==
1. Upload `wp-github` directory to the `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Add the widget through the 'Widgets' menu in WordPress or add the desired shortcode in your posts and pages.
== Frequently Asked Questions ==
= Which shortcodes are available? =
You can use the following codes to display profile, repositories, commits, issues and gists:
Embeed profile:
`[github-profile username="seinoxygen"]`
List last 10 repositories:
`[github-repos username="seinoxygen" limit="10"]`
List last 10 commits from all repositories:
`[github-commits username="seinoxygen" limit="10"]`
List last 10 commits from a specific repository:
`[github-commits username="seinoxygen" repository="wp-github" limit="45" xtended='{"Date de commit": "commit:committer:date","Email committer": "commit:committer:email","Url de commit": "url"}']`
List last 10 issues from all repositories:
`[github-issues username="seinoxygen" limit="10"]`
List last 10 issues from a specific repository:
`[github-issues username="seinoxygen" repository="wp-github" limit="10"]`
List last 10 gists from a specific user:
`[github-gists username="seinoxygen" limit="10"]`
== Screenshots ==
1. Setting up the widget.
2. Repositories widget in action!
3. Repositories embedded in a page.
4. Profile shortcode.
5. Profile widget.
== Changelog ==
= 1.3.3 =
fix all issues
= 1.3.2 =
add access token
fix widget commits "all" repo option
= 1.3.1 =
* Fix: gravatar profile
= 1.3 =
* New: Added shortcode button in tinyMce
* New: Added documentation in setting page
= 1.2.7 =
* New: Embed file content.
* Default username and repository, no need to add them eachtime.
* Added i18n
= 1.2.6 =
* New: Several fixes.
* New: Language support.
* New: Added shortcodes to link to issues and pull-requests.
* New: Display single issue.
= 1.2 =
* New: Custom styles.
* New: List all issues and commits from all public repositories
= 1.1 =
* New: Added "clear cache" and "cache time" functionality in settings page.
* New: Added profile widget and shortcode.
= 1.0 =
* First release