Skip to content

Commit

Permalink
Added README Sample to the core
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisChasm committed Jan 19, 2021
1 parent 38ea138 commit 2d1d31c
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 19 deletions.
50 changes: 50 additions & 0 deletions README-SAMPLE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
[![Build Status](https://travis-ci.com/DiscipleTools/disciple-tools-starter-plugin-template.svg?branch=master)](https://travis-ci.com/DiscipleTools/disciple-tools-starter-plugin-template)

# Disciple Tools - Name

Description Description Description Description Description Description Description
Description Description Description Description Description Description Description

## Purpose

Purpose purpose purpose purpose purpose purpose purpose purpose purpose purpose purpose
Purpose purpose purpose purpose purpose purpose purpose purpose purpose purpose purpose

Purpose purpose purpose purpose purpose purpose purpose purpose purpose purpose purpose
Purpose purpose purpose purpose purpose purpose purpose purpose purpose purpose purpose

## Usage

#### Will Do

- Item
- Item
- Item

#### Will Not Do

- Item
- Item

## Requirements

- Disciple Tools Theme installed on a Wordpress Server

## Installing

- Install as a standard Disciple.Tools/Wordpress plugin in the system Admin/Plugins area.
- Requires the user role of Administrator.

## Contribution

Contributions welcome. You can report issues and bugs in the
[Issues](https://github.com/DiscipleTools/disciple-tools-starter-plugin-template/issues) section of the repo. You can present ideas
in the [Discussions](https://github.com/DiscipleTools/disciple-tools-starter-plugin-template/discussions) section of the repo. And
code contributions are welcome using the [Pull Request](https://github.com/DiscipleTools/disciple-tools-starter-plugin-template/pulls)
system for git. For a more details on contribution see the
[contribution guidelines](https://github.com/DiscipleTools/disciple-tools-starter-plugin-template/blob/master/CONTRIBUTING.md).


## Screenshots

![spinner](https://via.placeholder.com/150)
46 changes: 27 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,38 +2,52 @@

# Disciple Tools - Starter Plugin Template

__Kick start your Disciple.Tools plugin project with this Disciple Tools plugin template!__
__Kick start your Disciple.Tools plugin project with this template!__

## Purpose

A team, organization, or movement effort might love Disciple.Tools, but __wish it had one more thing.__

We know that even though we have a common commission to make disciples of all nations, yet our assignments
on how to do that differ greatly or even if we share similar values our stages in movement differ. Either way,
we know we can't create everything everyone needs.

Instead of waiting for us, you can run ahead on your own. This
plugin includes all our best practices and starter codes for the most commonly developed extensions.

We have included starter code for a new post-type, a new REST API endpoint, a new admin page, or a new metrics chart.
The template also provides code quality and code style tools, Travis-CI integration, multi-language support, activation and
deactivation functions, and more. In truth it's likely more than your project needs, so we'll
guide you through removing the elements your project does not need.)

__This plugin is for developers__ who want to extend the Disciple Tools system for their movement effort.
__This plugin is for developers__ who want to extend the Disciple.Tools system for their movement effort.

## Usage

#### Can Do
#### Includes

- __Launch a new category of data inside Disciple Tools and cross reference it to other things like Contacts and Groups.__
(For example: If you need to announce a training to a small group of leaders. Then you can make the custom list for
those leaders, then use the export bcc link and the plugin will gather all the emails in the list and make them
available for quickly creating a new email in your email client, and write your message.)
1. Wordpress style requirements
1. Travis Continueous Integration
1. Disciple Tools Theme presence check
1. Remote upgrade system for ongoing updates outside the Wordpress Directory
1. Multilingual ready
1. PHP Code Sniffer support (composer) @use /vendor/bin/phpcs and /vendor/bin/phpcbf
1. Starter Admin menu and options page with tabs.

#### Can't Do
#### Doesn't Include

- __Does not facilitate integrations to other systems.__

####


## Installing

Installs as a standard plugin in the WP Admin area of the Disciple Tools system. Requires the role of Administrator.
- Composer
-


## Requirements

- __Map feature requires__ the installation of the free Mapbox key in the Disciple Tools mapping section.
- Disciple Tools System


## Contribution
Expand All @@ -49,13 +63,7 @@ system for git. For a more details on contribution see the [contribution guideli


### The starter plugin is equipped with:
1. Wordpress style requirements
1. Travis Continueous Integration
1. Disciple Tools Theme presence check
1. Remote upgrade system for ongoing updates outside the Wordpress Directory
1. Multilingual ready
1. PHP Code Sniffer support (composer) @use /vendor/bin/phpcs and /vendor/bin/phpcbf
1. Starter Admin menu and options page with tabs.


### Refactoring this plugin as your own:
1. Refactor all occurrences of the name `Starter_Plugin`, `starter_plugin`, `starter-plugin`, and `Starter Plugin` with you're own plugin
Expand Down

0 comments on commit 2d1d31c

Please sign in to comment.