-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
110 lines (73 loc) · 4.39 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
=== Blocks for GitHub ===
Contributors: dlocc
Tags: github, gutenberg blocks, github profile, repository display, developer tools
Requires at least: 6.0
Tested up to: 6.7
Requires PHP: 8.0
Stable tag: 1.0.0
License: GPL-2.0-or-later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Easily display your GitHub profile, organization, repositories, and more within the WordPress Block Editor aka "Gutenberg".
== Description ==
Seamlessly integrate GitHub content into your WordPress website using the block editor. This lightweight plugin lets you showcase GitHub profiles, organizations, and repositories with just a few clicks.
= Key Features =
* **GitHub Profile Block**: Display any GitHub user profile complete with:
* Profile picture and bio
* Location and website information
* Follow button with follower count
* Customizable display options
* **Repository Block**: Showcase GitHub repositories with:
* Repository description and statistics
* Star count and fork information
* Last update timestamps
* Customizable repository display options
* **Flexible Display Options**:
* Show/hide various profile elements (bio, location, website, etc.)
* Customize repository information display
* Control header background images
* Adjust profile name display
= Perfect For =
* Developers showcasing their GitHub projects
* Organizations displaying their open-source contributions
* Portfolio websites
* Development blogs
* Project documentation sites
= Contributing =
This is an open-source project and we welcome contributions of all kinds! Whether you're fixing bugs, improving documentation, or proposing new features, your help is welcome.
* View the source code on [GitHub](https://github.com/DevinWalker/blocks-for-github/)
* Found a bug? [Open an issue](https://github.com/DevinWalker/blocks-for-github/issues)
* Want to contribute? [View our contribution guidelines](https://github.com/DevinWalker/blocks-for-github/blob/main/CONTRIBUTING.md)
== Installation ==
Installation is easy!
Install right through the block editor or via the WordPress plugin directory search in your WordPress website.
1. Upload the plugin files to the `/wp-content/plugins/` directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the 'Plugins' screen in WordPress
3. Look for the GitHub blocks in your block editor
4. Start adding GitHub profiles and repositories to your posts and pages!
== Frequently Asked Questions ==
= Do I need a GitHub account to use this plugin? =
While you don't need a GitHub account to install the plugin, you'll need to know the GitHub username or repository information you want to display.
= Can I display private repositories? =
Currently, the plugin only displays public GitHub repositories and profiles.
= How do I customize what information is displayed? =
Each block has its own settings panel in the block editor sidebar. You can toggle various display options like showing/hiding the bio, location, website, follower count, and more.
= Can I display multiple profiles or repositories on the same page? =
Yes! You can add as many GitHub profile or repository blocks as you need to a single page or post.
= Will this plugin slow down my website? =
No, the plugin is designed to be lightweight and efficient, making API calls only when necessary to fetch GitHub data.
= How often is the GitHub information updated? =
The plugin caches GitHub data to ensure optimal performance while keeping information relatively fresh.
= I found a bug or have a suggestion =
Great! Please [open an issue on GitHub](https://github.com/DevinWalker/blocks-for-github/issues) to report bugs or suggest new features.
== Screenshots ==
1. Display and configure any GitHub profile or organization within the WordPress block editor. Customize the display options to show exactly what you want your visitors to see.
2. Have a repo that you want to showcase? No problem! Display any GitHub repository within the WordPress block editor. Show repository stats, descriptions, and more with easy configuration options.
3. Simple and intuitive block settings allow you to customize the display of GitHub content to match your needs.
== Changelog ==
= 1.0.0 =
* Initial Release - Yippee!
* Added GitHub Profile Block
* Added Repository Display Block
* Implemented customizable display options
* Added caching for optimal performance
* Included responsive design for all block displays