I2P "Supported" Product Template

This is a template with a set of minimal criteria for an application which "may" be considered a "supported" product by I2P. It is based on the criteria from: Endorse Projects Thread and any product which wants to be "Supported" should review those requirements as well. A copy of the criteria is archive in this repository under the file ZZZTHREAD.md

An example with information filled out for the I2P+Firefox Profile Installer is also available in this repository.

----------------------- Template Below Line ----------------------------------

Product Template ; This is the name of the product. It should be included on the product page.

Set a goal ; What is the product meant to accomplish? Express it as simply as possible.

Explain what you're trying to do ; This should go on the product page. Readable, understandable goal.

Explain non-goals, if necessary ; Not every project will need these, but it sometimes can help to clarify if you document them.

Explain what you're not trying to do ; Non goals should be specific and readable, but can be omitted from the product page.

Hows ; Explain how the product will accomplish it's goal.

Explain what you will do ; This is the section to explain the things that were too specific and complex to explain with a "Goal"

Who it's for ; Explain who should use a product and why they should.

Explain who the target audience is ; This might or not need to appear on the product page

Describe it's characteristics ; What kind of I2P Application is it?

Is it a Freestanding Application, ; Like XD, sam-forwarder an I2P Plugin, or ; Like I2P-Bote, Snark-RPC a third-party application extension? ; Like BiglyBT Plugin, I2P In Private Browsing
Does it embed an I2P Router, or ; If the application doesn't have an embedded does it require one to be installed? ; router, does it start an external I2P router?
What significant changes have been ; Changes to Base Dir and Config Dir don't need made to the configuration? ; to be noted, others should be listed here.
Will it run the Bandwidth ; If not, will you configure bandwidth in another way Configuration Wizard? ; or will you ask the user to configure bandwith
Anything else? ; Well?

Workspaces ; Tell people where the work takes place. This should all have a place on the product page.

Source Code ; Where does the code go?
Issue Reporting ; Where should non-sensitive issues be reported?
Security Reporting ; How should sensitive security issues be reported?

Licensing Information ; Tell people what they need to know to find the licenses distributed with the software.

Project License File ; Link to the license file of the main project. Needs to be on the main page
Additional Licensing Information ; Link to licenses of sub-projects, may be a directory if licenses are also included in the source code.

------------------ Copy/Paste this to get started ----------------------------

# Product Template			; This is the name of the product. It should be included on the product page.

## Set a goal				; What is the product meant to accomplish? Express it as simply as possible.

 - Explain what you're trying to do	; This should go on the product page. Readable, understandable goal.

## Explain non-goals, if necessary	; Not every project will need these, but it sometimes can help to clarify if you document them.

 - Explain what you're not trying to do	; Non goals should be specific and readable, but can be omitted from the product page.

### Hows				; Explain how the product will accomplish it's goal.

  1. Explain what you will do		; This is the section to explain the things that were too specific and complex to explain with a "Goal"

### Who it's for			; Explain who should use a product and why they should.

 - Explain who the target audience is	; This might or not need to appear on the product page

### Describe it's characteristics	; What kind of I2P Application is it?

 - Is it a Freestanding Application,	; Like XD, sam-forwarder
   an I2P Plugin, or 			; Like I2P-Bote, Snark-RPC
   a third-party application extension? ; Like BiglyBT Plugin, I2P In Private Browsing
 - Does it embed an I2P Router, or	; If the application doesn't have an embedded
   does it require one to be installed?	; router, does it start an external I2P router?
 - What significant changes have been	; Changes to Base Dir and Config Dir don't need
   made to the configuration?		; to be noted, others should be listed here.
 - Will it run the Bandwidth		; If not, will you configure bandwidth in another way
   Configuration Wizard?		; or will you ask the user to configure bandwith
 - Anything else?			; Well?

#### Workspaces				; Tell people where the work takes place. This should all have a place on the product page.

 - Source Code				; Where does the code go?
 - Issue Reporting			; Where should non-sensitive issues be reported?
 - Security Reporting			; How should sensitive security issues be reported?

#### Licensing Information		; Tell people what they need to know to find the licenses distributed with the software.

 - Project License File			; Link to the license file of the main project. Needs to be on the main page
 - Additional Licensing Information	; Link to licenses of sub-projects, may be a directory *if* licenses are also included in the source code.