README

Note: This readme template is based on one from the Good Docs Project. You can find it and a guide to filling it out here. (Erase this note after filling out the readme.)

Project Name

The project name should match its code's capability so that new users can easily understand what it does.

Owner(s)

Change to the owner(s) of the new repo. (This template's owners are:)

• @ngawangtrinley
• @mikkokotila
• @evanyerburgh

RFXs

Requests for work (RFWs) and requests for comments (RFCs) associated with this project:

• RFX name
• RFX name
• RFX name

Table of contents

Project description • Who this project is for • Project dependencies • Instructions for use • Contributing guidelines • Additional documentation • How to get help • Terms of use

Project description

Use one of these:

With Project Name you can verb noun...

Project Name helps you verb noun...

Who this project is for

This project is intended for target user who wants to user objective.

Project dependencies

Before using Project Name, ensure you have:

• Prerequisite 1
• Prerequisite 2
• Prerequisite 3...

Instructions for use

Get started with Project Name by (write the first step a user needs to start using the project. Use a verb to start.).

Install Project Name

1. Write the step here.

   Explanatory text here

   (Optional: Include a code sample or screenshot that helps your users complete this step.)

2. Write the step here.

   a. Substep 1

   b. Substep 2

Configure Project Name

1. Write the step here.
2. Write the step here.

Run Project Name

1. Write the step here.
2. Write the step here.

Troubleshoot Project Name

1. Write the step here.
2. Write the step here.

Other troubleshooting supports:

• Link to FAQs
• Link to runbooks
• Link to other relevant support information

Contributing guidelines

If you'd like to help out, check out our contributing guidelines.

Additional documentation

Include links and brief descriptions to additional documentation.

For more information:

• Reference link 1
• Reference link 2
• Reference link 3

How to get help

• File an issue.
• Email us at openpecha[at]gmail.com.
• Join our discord.

Terms of use

Project Name is licensed under the MIT License.