Skip to content
This repository has been archived by the owner on May 1, 2024. It is now read-only.

Commit

Permalink
Update version number in readme files.
Browse files Browse the repository at this point in the history
This sets the current version number to 0.1.0.

* Adds a package.json file to the project.
* Includes the wp-readme-to-markdown npm package to create a README.md file from the standard readme.txt file using the command `npm run readme`.
  • Loading branch information
joemcgill committed Jun 9, 2020
1 parent a5c4fb9 commit 0073f80
Show file tree
Hide file tree
Showing 5 changed files with 94 additions and 31 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ node_modules/
*.sql
*.tar.gz
*.zip
vendor/
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# WP Irving #

WP Irving contains everything needed to power an Irving headless app with WordPress.

## Description ##

WP Irving is the companion WordPress plugin to [Irving](https://github.com/alleyinteractive/irving). Included are various APIs, plugin integrations, and other customizations/helpers to streamline Irving development when using WordPress as the CMS. It registers the API endpoints that Irving Core expects, which you can build upon to pass your data from WordPress to the frontend.

While WP Irving contains a few basic plugin integrations (and we hope to support more in the plugin in the future), overall the plugin is rather lightweight. It provides the tools you need to structure your API data appropriately for Irving, but it is up to you to build out the responses.

## Installation ##

1. Upload `/wp-irving/` folder to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress

## Changelog ##

### 0.1.0 ###
First stable release of the WP-Irving plugin.
23 changes: 23 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

28 changes: 28 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"name": "wp-irving",
"version": "0.1.0",
"description": "WordPress plugin to integrate with an Irving headless site.",
"dependencies": {},
"devDependencies": {
"wp-readme-to-markdown": "^1.0.1"
},
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"readme": "wp-readme-to-md"
},
"repository": {
"type": "git",
"url": "git+https://github.com/alleyinteractive/wp-irving.git"
},
"keywords": [
"WordPress",
"Irving",
"headless"
],
"author": "Alley Interactive",
"license": "GPL-2.0+",
"bugs": {
"url": "https://github.com/alleyinteractive/wp-irving/issues"
},
"homepage": "https://github.com/alleyinteractive/wp-irving#readme"
}
54 changes: 23 additions & 31 deletions readme.txt
Original file line number Diff line number Diff line change
@@ -1,31 +1,23 @@
=== WP Irving ===
Contributors: jameswalterburke
Tags: irving, headless
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

WP Irving contains everything needed to power an Irving site with WordPress.

== Description ==

More soon.

== Installation ==

1. Upload `/wp-irving/` folder to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress

== Frequently Asked Questions ==

= A question that someone might have =

An answer to that question.

= What about foo bar? =

Answer to foo bar dilemma.

== Changelog ==

= 1.0 =
Initial open source release.
=== WP Irving ===
Contributors: alleyinteractive
Tags: irving, headless
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

WP Irving contains everything needed to power an Irving headless app with WordPress.

== Description ==

WP Irving is the companion WordPress plugin to [Irving](https://github.com/alleyinteractive/irving). Included are various APIs, plugin integrations, and other customizations/helpers to streamline Irving development when using WordPress as the CMS. It registers the API endpoints that Irving Core expects, which you can build upon to pass your data from WordPress to the frontend.

While WP Irving contains a few basic plugin integrations (and we hope to support more in the plugin in the future), overall the plugin is rather lightweight. It provides the tools you need to structure your API data appropriately for Irving, but it is up to you to build out the responses.

== Installation ==

1. Upload `/wp-irving/` folder to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress

== Changelog ==

= 0.1.0 =
First stable release of the WP-Irving plugin.

0 comments on commit 0073f80

Please sign in to comment.