We had recently introduced the wordpress plugin GK Steemit Info, today we present the official documentation for the plugin.
If you missed the introductory article, you can find it here Wordpress Plugin: GK Steemit Info
As a quick recap, the plugin servers as means to allow wordpress solutions to include steemit related data as widgets or shortcodes on the relevant site. This is accomplished via connecting to the steemjs API and pulling the needed info, and could serve as great promotional tool for steemit.
The plugin's code and documentation are all accessible under the official plugin's Github repository
The documentation has been submitted under the readme.md file and is publicly available. Following is a link to the documentation commit
An exact copy of the documentation is also found below for ease of access:
=== Plugin Name ===
Plugin Name: GK Steemit Info
Contributors: mcfarhat
Tags: wordpress, steemit, widget, user count
Requires at least: 4.3
Tested up to: 4.9
Stable tag: trunk
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
=== Short Summary ===
The plugin serves as a means to add, into your current wordpress installation, one or more widgets/shortcodes that allow displaying steemit related info
== Description ==
Steemit.com is a fast growing social network/blogging platform that rewards authors and curators for quality content via the concept of upvotes (likes)
We believe that providing proper means to integrate information from steemit into wordpress will lead the way for further growth to the platform, particularly via widgets/shortcodes as they are easiest to embed for any wordpress site owner, without needed development skills.
Using GK Steemit Info, you now have the capability to create widgets or embed shortcodes to your wordpress solution.
In this initial version, you can now embed a widget that allows displaying the current number of users registered on steemit, at this instant over 500,000 users are signed up on steemit.
The widget allows you to set a proper title for the widget, but also to set the data refresh frequency. The default value is at 5,000 ms (5 seconds), and can be increased in increments of 500 ms (half a second) each depending if you have any other computing intensive functionality on your site.
The widget also includes a link to refer people to steemit.com as a promotional aspect of the widget.
You can alternatively use the shortcode version, through using [steemit_user_count refresh_frequency=5000] whereby refresh_frequency defines how often to refresh fetching the data. You can skip on setting this param and it defaults to 5,000 ms (5 seconds) as well.
If you would like some custom work done, or have an idea for a plugin you're ready to fund, check our site at www.greateck.com or contact us at [email protected]
== Installation ==
- Upload the plugin files to the
/wp-content/plugins/gk-steemit-infodirectory, or install the plugin through the WordPress plugins screen directly.- Activate the plugin through the 'Plugins' screen in WordPress
- a. Go to the appearance -> widgets screen, and add in the "Steemit Info Widget" widget, and set the title and/or refresh frequency.
- b. Alternatively use the shortcode steemit_user_count highlighted above on any page or within your code.
- That's it!
== Screenshots ==
- Screenshot showing the new "Steemit Info Widget" https://www.dropbox.com/s/macix3vv85gme2b/new_widget.png?dl=0
- Screenshot showing the options of the widget once added https://www.dropbox.com/s/stgttgdgrvpncx1/widget_options.png?dl=0
== Changelog ==
= 0.1.0 =
Initial Version
Posted on Utopian.io - Rewarding Open Source Contributors
Thanks for sharing this post I like your post
Good Information
Thanks for the good information. I like that the widget refers to steemit.
It's a very helpful post for me. I have benefited reading this post.Hope everyone will like your post.
Glad new year! 2018 will be an incredible year. What an adventure it has been with Steem. We both have seen a considerable measure over the previous year or something like that. This undertaking has shown me to such an extent. The things I have learned are worth more than any measure of cash en route. I see the world in an entirely different manner after all I have learned since beginning with Blockchains. I truly trust the world is moving into a superior place. In the expressions of the colossal Naveen Jain we as a whole should "have an outlook of plenitude". This blockchain can be a device to change the world for good and show individuals numerous things if utilized as a part of the correct way. Information is power and It will be a blockchain loaded with learning. The Steem blockchain is getting more grounded by the day. We have seen some astounding development since this blockchain began and I know this is just the begin. When we have a completely refined item it will have the capacity to do things we cannot envision yet. The expansion of SMTs into the blockchain will intrigue and will change the way we consider the web and what is conceivable. Groups and discussions are a gigantic piece of the web. The conceivable utilizations of SMTs are stunning to consider. With Steemit and Steem we are now rolling out improvements in places that need it and offering assistance to those in require. Envision what's on the horizon for us and this blockchain. We additionally have an incredible group behind this blockchain. That is one of the principle reasons I put my BTC into this task over a year prior in the wake of discovering it on the Bitcointalk gathering and faltering onto Steemit through google look through a couple of times (accidentally hunting down different things). I at that point started some examination and saw @dan talking a couple of times about Steem. At that point saw @ned talking on YouTube and on CheddarTV and knew instinctively then he was resolved to make something extraordinary. Its awesome to see designers as you doing extraordinary things for the eco framework also @exyle with things like Steemify and Blockbrothers. - Lets take Steemit and Steem to the following level in 2018!
I don't use WordPress, I find it too restricting. I write my own CMS. I can, however, see the value of this plugin to those Steemians who do use WP. Well done and good luck.
Trust me, I'm a doctor.
well done brother, thanks for sharing informative and educational content .
Thank you for the contribution. It has been approved.
You can contact us on Discord.
[utopian-moderator]
Hey @mcfarhat I am @utopian-io. I have just upvoted you!
Achievements
Community-Driven Witness!
I am the first and only Steem Community-Driven Witness. Participate on Discord. Lets GROW TOGETHER!
Up-vote this comment to grow my power and help Open Source contributions like this one. Want to chat? Join me on Discord https://discord.gg/Pc8HG9x
This will be a great tool for wp.