Skip to content

Commit

Permalink
📝 Update docs for WordPress.org release
Browse files Browse the repository at this point in the history
  • Loading branch information
davisshaver committed May 10, 2022
1 parent 333bfeb commit 465392f
Show file tree
Hide file tree
Showing 7 changed files with 64 additions and 34 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/generate-zip.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ jobs:
with:
type: 'zip'
filename: 'wp-rainbow.zip'
exclusions: '/*node_modules/* composer.* wp-rainbow-filter-examples.php package.json phpcs.xml phpunit.xml /*public/* bin/ bin/install-wp-tests.sh /*tests/* yarn.lock webpack.config.js .gitignore /*.git/* .babelrc /*.phpcs/* /*.github/*'
exclusions: '/*node_modules/* composer.* wp-rainbow-filter-examples.php readme.md package.json phpcs.xml phpunit.xml /*public/* bin/ bin/install-wp-tests.sh /*tests/* yarn.lock webpack.config.js .gitignore /*.git/* .babelrc /*.phpcs/* /*.github/*'

- name: Upload artifact
uses: actions/upload-artifact@v2
Expand Down
Binary file added .wordpress-org/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 .wordpress-org/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.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "wp-rainbow",
"version": "0.1.4",
"version": "0.1.5",
"description": "RainbowKit Login (Web3 Integration for Sign-In With Ethereum)",
"author": "Davis Shaver",
"license": "GPL-2.0-or-later",
Expand Down
35 changes: 6 additions & 29 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,16 @@
# RainbowKit Login (Web3 Integration for Sign-In With Ethereum)

Plugin URI: <https://wp-rainbow.davisshaver.com/>
Description: WP Rainbow allows WordPress users to log in with Ethereum using the Sign-In With Ethereum standard, powered by RainbowKit.
Version: 0.1.4
Author: Davis Shaver
Author URI: <https://davisshaver.com>
License: GPL v2 or later
License URI: <https://www.gnu.org/licenses/gpl-2.0.html>
Text Domain: wp-rainbow
Update URI: <https://github.com/davisshaver/wp-rainbow>
Tags: WordPress, web3, SIWE, Ethereum, RainbowKit, Sign-In With Ethereum
Contributors: davisshaver

![WP Rainbow Plugin Banner](.wordpress-org/banner-1544x500.png)

Providing a [Sign-In With Ethereum](https://login.xyz/) experience for [WordPress](https://wordpress.org/) using [RainbowKit](https://www.npmjs.com/package/@rainbow-me/rainbowkit).
# WP Rainbow

[![PHPUnit Tests](https://github.com/davisshaver/wp-rainbow/actions/workflows/phpunit-tests.yml/badge.svg)](https://github.com/davisshaver/wp-rainbow/actions/workflows/phpunit-tests.yml)

## Description

Providing a [Sign-In With Ethereum](https://login.xyz/) experience for [WordPress](https://wordpress.org/) using [RainbowKit](https://www.npmjs.com/package/@rainbow-me/rainbowkit).

_Want to try it out? [Head here.](https://wp-rainbow.davisshaver.com/wp-login.php)_

### Features

* Allow users to log in with Ethereum
* Set required token balance for login

### Installation
## Installation

The recommended way to install WP Rainbow is downloading the plugin from WordPress.org. Alternatively, download the ZIP file from [the most recent release](https://github.com/davisshaver/wp-rainbow/releases).
The recommended way to install WP Rainbow is downloading the ZIP file from [the most recent release](https://github.com/davisshaver/wp-rainbow/releases).

### Development
## Development

Before you begin, make sure you have [Composer](https://getcomposer.org/) and [Yarn](https://yarnpkg.com/) available.

Expand All @@ -59,7 +36,7 @@ Before you begin, make sure you have [Composer](https://getcomposer.org/) and [Y

_Note: This plugin requires [GMP](https://www.php.net/manual/en/book.gmp.php) to be available on the server._

### Actions
## Actions

**`wp_rainbow_validation_failed`** - Fires when validation fails.

Expand All @@ -69,7 +46,7 @@ _Note: This plugin requires [GMP](https://www.php.net/manual/en/book.gmp.php) to

**`wp_rainbow_user_login`** - Fires when user logs in.

### Filters
## Filters

Find reference implementations of all filters in [example plugin here](https://github.com/davisshaver/wp-rainbow/blob/main/wp-rainbow-filter-examples.php).

Expand Down
54 changes: 54 additions & 0 deletions readme.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
=== RainbowKit Login (Web3 Integration for Sign-In With Ethereum) ===
Contributors: davisshaver
Tags: WordPress, web3, SIWE, Ethereum, RainbowKit, Sign-In With Ethereum
Tested up to: 6.0
Requires at least: 5.9
Requires PHP: 7.0
Stable tag: 0.1.5
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

WP Rainbow allows WordPress users to log in with Ethereum using the Sign-In With Ethereum standard, powered by RainbowKit.

== Description ==

Providing a [Sign-In With Ethereum](https://login.xyz/) experience for [WordPress](https://wordpress.org/) using [RainbowKit](https://www.npmjs.com/package/@rainbow-me/rainbowkit).

- Allow users to log in with Ethereum
- Set required token balance for login

_Want to try it out? [Head here.](https://wp-rainbow.davisshaver.com/wp-login.php)_

== Frequently Asked Questions ==

= What filters are included? =

Find reference implementations of all filters in [example plugin here](https://github.com/davisshaver/wp-rainbow/blob/main/wp-rainbow-filter-examples.php).

**`wp_rainbow_nonce_life`** - Filter amount of time before nonce expires.

**`wp_rainbow_role_for_address`** - Filter role granted to a specific address on sign-in.

**`wp_rainbow_infura_id`** - Filter Infura ID to override settings value.

**`wp_rainbow_redirect_url`** - Filter login redirect URL.

= What actions are included? =

**`wp_rainbow_validation_failed`** - Fires when validation fails.

**`wp_rainbow_user_created`** - Fires when user created.

**`wp_rainbow_user_updated`** - Fires when user updated.

**`wp_rainbow_user_login`** - Fires when user logs in.

== Changelog ==

= 0.1.5 =
* Initial plugin release to WordPress.org

== Screenshots =

1. RainbowKit Login allows users to log in using their Ethereum wallet
2. RainbowKit Login includes a login block that can be customized
5 changes: 2 additions & 3 deletions wp-rainbow.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,12 @@
* Plugin Name: RainbowKit Login (Web3 Integration for Sign-In With Ethereum)
* Plugin URI: https://wp-rainbow.davisshaver.com/
* Description: WP Rainbow allows WordPress users to log in with Ethereum using the Sign-In With Ethereum standard, powered by RainbowKit.
* Version: 0.1.4
* Version: 0.1.5
* Author: Davis Shaver
* Author URI: https://davisshaver.com/
* License: GPL v2 or later
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
* Text Domain: wp-rainbow
* Update URI: https://github.com/davisshaver/wp-rainbow
* Tags: WordPress, web3, SIWE, Ethereum, RainbowKit, Sign-In With Ethereum
* Contributors: davisshaver
*/
Expand All @@ -28,7 +27,7 @@
*
* @var string
*/
define( 'WP_RAINBOW_ASSETS_VERSION', '0.1.4' );
define( 'WP_RAINBOW_ASSETS_VERSION', '0.1.5' );

// Include the autoloader.
add_action(
Expand Down

0 comments on commit 465392f

Please sign in to comment.