-
Notifications
You must be signed in to change notification settings - Fork 2
/
readme.txt
95 lines (74 loc) · 3.37 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
=== My Github ===
Plugin Name: My Github
Version: 1.2.4
Author: Ratul Hasan
Contributors: ratulhasan, rajankarmakar
Tags: github, profile, portfolio, developer, development, embed, oembed
Requires at least: 5.2
Tested up to: 6.4.2
Requires PHP: 5.6
Stable tag: trunk
License: GPL-2.0-or-later
License URI: https://www.gnu.org/licenses/gpl-3.0.en.html
A simple and nice WordPress plugin that can track your github's profile.
== Description ==
A simple and nice WordPress plugin that can track your GitHub's profile. You can showcase your Followers, Following, Company, Location, Blog URL, Twitter Account, Public Repositories, Public Repository's Used Language.
If the installation is okay, go and create a page and/or post or update a page and/or post and insert a Shortcode 👉 [my_github] to show your profile.
You can also find Quick Tags in your editor. You can also setup your settings from My GitHub under Settings page. That's it.
**Currently supports:**
- Editor ShortCode support
- GitHub Widget Profile View
- User profiles
- Repositories
- Used Main Language
- Repository Star Count
- Repository Watcher Count
- Repository Fork Count
- Repository License
- Repository's Last Pushed Time
- Add custom template option.
Developers can also add their custom header name by using the hook `git_name_header` like this
``
add_filter('git_name_header', function($url){
return "My Github Showcase";
});
``
Developers can also add their custom template by using the hook `my_github_custom_template` like this
``
add_filter('my_github_custom_template', function($url){
return /template_path/file.php";
});
``
The plugin provides very basic styling. If anyone has any ideas for a better styling - pull requests are welcome!
The development repo is [GitHub Repo](https://github.com/RatulHasan/my-github).
== Installation ==
Installation is fairly straight forward. Install it from the WordPress plugin repository.
= Bugs, technical hints or contribute =
Please give us feedback, contribute and file technical bugs on [GitHub Repo](https://github.com/RatulHasan/my-github).
== Frequently Asked Questions ==
= Can I change the layout? =
Yes! we added custom template, but it's style is very basic - [Contribute](https://github.com/RatulHasan/my-github)!
## Privacy Policy
My Github uses [Appsero](https://appsero.com) SDK to collect some telemetry data upon user's confirmation. This helps us to troubleshoot problems faster & make product improvements.
Appsero SDK **does not gather any data by default.** The SDK only starts gathering basic telemetry data **when a user allows it via the admin notice**. We collect the data to ensure a great user experience for all our users.
Integrating Appsero SDK **DOES NOT IMMEDIATELY** start gathering data, **without confirmation from users in any case.**
Learn more about how [Appsero collects and uses this data](https://appsero.com/privacy-policy/).
== Screenshots ==
1. GitHub Profile
2. GitHub Widget Setup
3. GitHub Widget Profile View
== Changelog ==
= 1.2.4 =
* Tested with the new WordPress version 6.4.2
= 1.2.3 =
* Tested with the new WordPress version 6.2
= 1.2.2 =
* Add custom template option.
= 1.2.1 =
* Add Classic Editor ShortCode support.
= 1.2.0 =
* Add GitHub Widget Profile View.
= 1.1.0 =
* Add Personal Access Token to authenticate a user [Token](https://github.com/settings/tokens).
= 1.0.0 =
* Initial Release