Skip to content

Commit

Permalink
Improved documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
KSym04 committed Mar 25, 2019
1 parent e4820cf commit 71fb687
Show file tree
Hide file tree
Showing 7 changed files with 132 additions and 9 deletions.
68 changes: 68 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
sudo: false
dist: trusty

language: php

addons:
chrome: stable
apt:
packages:
- nginx

env:
- WP_VERSION=latest WP_MULTISITE=0

php:
- 5.6
- 7.0
- 7.1
- 7.2
- 7.3

notifications:
email:
on_success: never
on_failure: change

cache:
directories:
- vendor
- $HOME/.composer/cache

matrix:
fast_finish: true
include:
- php: 7.2
- php: 7.2
- php: 7.1
- php: 7.0
- php: 5.6
- php: 5.5
- php: 5.4
- php: 5.3
dist: precise

before_script:
- export PATH="$HOME/.composer/vendor/bin:$PATH"
- |
if [ -f ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/xdebug.ini ]; then
phpenv config-rm xdebug.ini
else
echo "xdebug.ini does not exist"
fi
- |
if [[ "$WP_TRAVISCI" == "phpcs" ]] ; then
composer global require wp-coding-standards/wpcs
phpcs --config-set installed_paths $HOME/.composer/vendor/wp-coding-standards/wpcs
fi
script:
- |
if [[ "$WP_TRAVISCI" == "phpcs" ]] ; then
phpcs
fi
branches:
only:
- master
- /^\d+\.\d+(\.\d+)?(-\S*)?$/
48 changes: 45 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,46 @@
Crypto QR Code WP
=========================
# Crypto QR Code WP #

Add cryptocurrencies QR code donate with lightbox.
[![Build Status](https://travis-ci.org/KSym04/crypto-qr-code-wp.svg?branch=master)](https://travis-ci.org/KSym04/crypto-qr-code-wp)

**Contributors:** ksym04\
**Tags:** crypto, bitcoin, cryptocurrency, qr code\
**Requires at least:** 4.7\
**Tested up to:** 5.1.1\
**Stable tag:** 1.0.1\
**License:** GPLv3\
**License URI:** [https://www.gnu.org/licenses/gpl-3.0.html](https://www.gnu.org/licenses/gpl-3.0.html)

Add cryptocurrencies QR code donate with tooltip.

## Description ##

Crypto QR Code WP - Creates an element consist of a label and link with tooltip popup QR code by setting up the cryptocurrency name and its public key wallet address.

Disclaimer: Only used your wallet public key address and never ever reveal your private key, any misuse results from loss of balance is not our liabilities.

## Installation ##

1. Download the plugin via WordPress.org
2. Upload the `crypto-qr-code-wp` directory to the `/wp-content/plugins/` directory via FTP
3. Activate the plugin through the 'Plugins' menu in WordPress

## Frequently Asked Questions ##

### How to use the Crypto QR Code generator shortcode ###

The shortcode 'cqcw_generator' has three parameters - heading, label and address. Sample: `[cqcw_generator heading="Donate" label="BTC" address="1GJpyaLZjQ8JKaKih3UCwpuJAV15fTy9Rq"]`

## Translations ##

* English (en_US)

## Changelog ##

### 1.0.1 - Mar 26, 2019 ###

* New - Added 'Crypto QR Code' widget
* Tweak - Enhanced file security

### 1.0.0 - Mar 24, 2019 ###

* Initial Release
2 changes: 1 addition & 1 deletion changelog.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
*** Crypto QR Code WP Changelog ***

2019.03.29 - version 1.0.1
2019.03.26 - version 1.0.1
* New - Added 'Crypto QR Code' widget
* Tweak - Enhanced file security

Expand Down
4 changes: 2 additions & 2 deletions crypto-qr-code-wp.php
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ public function initialize() {
* register_assets
*
* @type function
* @date 03/24/19
* @date 03/26/19
* @since 1.0.0
*/
function register_assets() {
Expand All @@ -111,7 +111,7 @@ function register_assets() {
* create_file_resources
*
* @type function
* @date 03/25/19
* @date 03/26/19
* @since 1.0.1
*/
function create_file_resources() {
Expand Down
19 changes: 16 additions & 3 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,39 @@ Contributors: ksym04
Tags: crypto, bitcoin, cryptocurrency, qr code
Requires at least: 4.7
Tested up to: 5.1.1
Stable tag: 1.0.0
Stable tag: 1.0.1
License: GPLv3
License URI: https://www.gnu.org/licenses/gpl-3.0.html

Add cryptocurrencies QR code donate with tooltip.

== Description ==

...
Crypto QR Code WP - Creates an element consist of a label and link with tooltip popup QR code by setting up the cryptocurrency name and its public key wallet address.

Disclaimer: Only used your wallet public key address and never ever reveal your private key, any misuse results from loss of balance is not our liabilities.

== Installation ==

1. Download the plugin via WordPress.org
2. Upload the `crypto-qr-code-wp` directory to the `/wp-content/plugins/` directory via FTP
3. Activate the plugin through the 'Plugins' menu in WordPress

== Screenshots ==

1. Sample Bitcoin address with tooltip
2. Sample Cardano address with tooltip

== Frequently Asked Questions ==

= How to use the Crypto QR Code generator shortcode? =

The shortcode 'cqcw_generator' has three parameters - heading, label and address. Sample: cqcw_generator heading="Donate" label="BTC" address="1GJpyaLZjQ8JKaKih3UCwpuJAV15fTy9Rq"

== Changelog ==

= 1.0.1 =
* 2019-03-29
* 2019-03-26
* New - Added 'Crypto QR Code' widget
* Tweak - Enhanced file security

Expand Down
Binary file added screenshots/screenshot-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/screenshot-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 71fb687

Please sign in to comment.