Skip to content

Commit 3d46c89

Browse files
committed
Update readme.txt for launch
1 parent c8a5ff3 commit 3d46c89

File tree

1 file changed

+77
-13
lines changed

1 file changed

+77
-13
lines changed

readme.txt

Lines changed: 77 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,110 @@
11
=== Blocks for GitHub ===
22
Contributors: dlocc
3-
Tags: github, github block, block github, github blocks, blocks github
3+
Tags: github, github block, block github, github blocks, blocks github, repository display, github profile, github integration, gutenberg blocks
44
Requires at least: 6.0
55
Tested up to: 6.7
66
Requires PHP: 8.0
77
Stable tag: 1.0.0
88
License: GPL-2.0-or-later
99
License URI: https://www.gnu.org/licenses/gpl-2.0.html
1010

11-
Easily display your GitHub profile, organization, repositories, gists, and more within the WordPress Block Editor aka "Gutenberg".
11+
Easily display your GitHub profile, organization, repositories, and more within the WordPress Block Editor aka "Gutenberg".
1212

1313
== Description ==
1414

15-
Welcome to your home base for everything GitHub and WordPress' block editor "Gutenberg". This lightweight, yet powerful plugin, unlocks your ability to display your GitHub profile, organization, repositories, and more right inside the WordPress block editor.
15+
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.
16+
17+
= Key Features =
18+
19+
* **GitHub Profile Block**: Display any GitHub user profile complete with:
20+
* Profile picture and bio
21+
* Location and website information
22+
* Follow button with follower count
23+
* Customizable display options
24+
25+
* **Repository Block**: Showcase GitHub repositories with:
26+
* Repository description and statistics
27+
* Star count and fork information
28+
* Last update timestamps
29+
* Customizable repository display options
30+
31+
* **Flexible Display Options**:
32+
* Show/hide various profile elements (bio, location, website, etc.)
33+
* Customize repository information display
34+
* Control header background images
35+
* Adjust profile name display
36+
37+
= Perfect For =
38+
39+
* Developers showcasing their GitHub projects
40+
* Organizations displaying their open-source contributions
41+
* Portfolio websites
42+
* Development blogs
43+
* Project documentation sites
44+
45+
= Contributing =
46+
47+
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.
48+
49+
* View the source code on [GitHub](https://github.com/DevinWalker/blocks-for-github/)
50+
* Found a bug? [Open an issue](https://github.com/DevinWalker/blocks-for-github/issues)
51+
* Want to contribute? [View our contribution guidelines](https://github.com/DevinWalker/blocks-for-github/blob/main/CONTRIBUTING.md)
1652

1753
== Installation ==
1854

1955
Installation is easy!
2056

2157
Install right through the block editor or via the WordPress plugin directory search in your WordPress website.
2258

23-
e.g.
24-
2559
1. Upload the plugin files to the `/wp-content/plugins/` directory, or install the plugin through the WordPress plugins screen directly.
2660
2. Activate the plugin through the 'Plugins' screen in WordPress
27-
61+
3. Look for the GitHub blocks in your block editor
62+
4. Start adding GitHub profiles and repositories to your posts and pages!
2863

2964
== Frequently Asked Questions ==
3065

31-
= A question that someone might have =
66+
= Do I need a GitHub account to use this plugin? =
67+
68+
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.
69+
70+
= Can I display private repositories? =
3271

33-
An answer to that question.
72+
Currently, the plugin only displays public GitHub repositories and profiles.
73+
74+
= How do I customize what information is displayed? =
75+
76+
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.
77+
78+
= Can I display multiple profiles or repositories on the same page? =
79+
80+
Yes! You can add as many GitHub profile or repository blocks as you need to a single page or post.
81+
82+
= Will this plugin slow down my website? =
83+
84+
No, the plugin is designed to be lightweight and efficient, making API calls only when necessary to fetch GitHub data.
85+
86+
= How often is the GitHub information updated? =
87+
88+
The plugin caches GitHub data to ensure optimal performance while keeping information relatively fresh.
89+
90+
= I found a bug or have a suggestion =
91+
92+
Great! Please [open an issue on GitHub](https://github.com/DevinWalker/blocks-for-github/issues) to report bugs or suggest new features.
3493

3594
== Screenshots ==
3695

37-
1. This screenshot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from
38-
the /assets directory or the directory that contains the stable readme.txt (tags or trunk). Screenshots in the /assets
39-
directory take precedence. For example, `/assets/screenshot-1.png` would win over `/tags/4.3/screenshot-1.png`
40-
(or jpg, jpeg, gif).
41-
2. This is the second screenshot
96+
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.
97+
98+
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.
99+
100+
3. Simple and intuitive block settings allow you to customize the display of GitHub content to match your needs.
42101

43102
== Changelog ==
44103

45104
= 1.0.0 =
46105
* Initial Release - Yippee!
106+
* Added GitHub Profile Block
107+
* Added Repository Display Block
108+
* Implemented customizable display options
109+
* Added caching for optimal performance
110+
* Included responsive design for all block displays

0 commit comments

Comments
 (0)