Skip to content

Commit

Permalink
modified readme and license info
Browse files Browse the repository at this point in the history
  • Loading branch information
Tyler Kemme committed Mar 1, 2017
1 parent 6186404 commit 8de0142
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 11 deletions.
38 changes: 30 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,46 @@
# WP Cloudflare Dashboard #
**Contributors:** Tyler Kemme
**Requires at least:** 4.4
**Tested up to:** 4.7.2
**Tested up to:** 4.7.2
**Stable tag:** 0.3.1
**License:** MIT
**License:** GPLv2
**License URI:** http://www.gnu.org/licenses/gpl-2.0.html

## Description ##

A Cloudflare Analytics Dashboard for Wordpress.
A Cloudflare Analytics Dashboard for Wordpress. Simply enter your Cloudflare Email Address and Cloudflare API Key and you can access the analytics dashboards for each of your sites on Cloudflare.

## Installation ##

### Manual Installation ###
### Installation through Wordpress ###

1. Upload the entire `/wp-cloudflare-dashboard` directory to the `/wp-content/plugins/` directory.
2. Activate WP Cloudflare Dashboard through the 'Plugins' menu in WordPress.
1. Download the latest release

## Frequently Asked Questions ##
2. Upload the entire `/wp-cloudflare-dashboard` directory to the `/wp-content/plugins/` directory OR upload the plugin using the Wordpress 'Plugins' menu.

3. Activate WP Cloudflare Dashboard through the 'Plugins' menu in WordPress.

## Screenshots ##
### Installation for Developers ###

1. Clone the repository to `/wp-content/plugins`
`git clone https://github.com/tpkemme/wp-cloudflare-dashboard.git`

2. Install dependencies with composer and npm
`composer install && npm install --only=dev`

## Contributing ##

Use the `npm version` command to increment the version number for the plugin across all files. The command `composer dist` can be used to create a new 'dist' branch. The 'dist' branch contains only the files necessary for the functionality of the plugin. All development files are removed from the 'master' branch to create the 'dist' branch.

The typical developer's workflow looks something like this:

1. Add and push any changes made to the repo
`git add -A && git commit -m "example commit" && git push origin master`

2. Update the version
`npm version minor`

3. Create a new distribution release
`composer dist`

## Screenshots ##
4 changes: 2 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"description": "A Cloudflare Analytics Dashboard for Wordpress.",
"keywords": ["wordpress", "plugin", "generator-plugin-wp"],
"homepage": "https://tacticalwp.com",
"license": "MIT",
"license": "GPLv2",
"authors": [
{
"name": "Tyler Kemme",
Expand All @@ -26,6 +26,6 @@
"classmap": ["wp-cloudflare-dashboard.php", "includes/"]
},
"scripts": {
"dist": "git push origin dist && git branch -D dist && git push origin :dist && git checkout -B dist && rm -rf .bowerrc .editorconfig .eslintrc.js .eslintrc.json .gitignore .sass-lint.yml .travis.yml .yo-rc.json bower.json composer.lock Gruntfile.js Gulpfile.js phpcs.xml phpunit.xml README.md tests node_modules bin assets/README.md assets/css/sass assets/js assets/repo includes/README.md && composer install && rm -rf .gitignore composer.lock .DS_Store assets/.DS_Store && git add -A && git commit -m $(grep -m1 version package.json | awk -F: '{ print $2 }' | sed 's/[\", ]//g') && git push origin dist"
"dist": "git push origin dist && git branch -D dist && git push origin :dist && git checkout -B dist && rm -rf .bowerrc .editorconfig .eslintrc.js .eslintrc.json .gitignore .sass-lint.yml .travis.yml .yo-rc.json bower.json composer.lock Gruntfile.js Gulpfile.js phpcs.xml phpunit.xml tests node_modules bin assets/README.md assets/css/sass assets/js assets/repo includes/README.md && composer install && rm -rf .gitignore composer.lock .DS_Store assets/.DS_Store && git add -A && git commit -m $(grep -m1 version package.json | awk -F: '{ print $2 }' | sed 's/[\", ]//g') && git push origin dist"
}
}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"name": "Tyler Kemme",
"url": "https://tylerkemme.com"
},
"license": "MIT",
"license": "GPLv2",
"devDependencies": {
"auto-changelog": "^0.3.1",
"autoprefixer": "latest",
Expand Down

0 comments on commit 8de0142

Please sign in to comment.