This repository has been archived by the owner on Mar 11, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Created a template for more consistent instruction format Updated the readme to reflect a more structured process for box creation DO NOT MERGE until box docs have been updated and truffle boxes have been cleaned up
- Loading branch information
1 parent
d196f44
commit 9c06db9
Showing
2 changed files
with
69 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# [BOX NAME] | ||
|
||
- [Requirements](#requirements) | ||
- [Setup](#setup) | ||
- [Installation](#installation) | ||
- [Deployment](#deployment) | ||
- [Usage](#usage) | ||
- [Commands](#commands) | ||
- [Testing](#testing) | ||
- [Support](#support) | ||
|
||
[BOX DESCRIPTION: Here you should introduce what your box is, give any background information if necessary, and why people should use it!] | ||
|
||
## Requirements | ||
|
||
The [BOX NAME] box has the following requirements: | ||
|
||
- [REPLACE OR ADD REQUIREMENTS AND HOW TO DOWNLOAD] | ||
- [Node.js](https://nodejs.org/) 10.x or later | ||
- [NPM](https://docs.npmjs.com/cli/) version 5.2 or later | ||
|
||
Helpful, but optional: | ||
- An [Infura](https://infura.io/) account and Project ID | ||
- A [MetaMask](https://metamask.io/) account | ||
|
||
## Setup | ||
|
||
### Installation | ||
|
||
[INSTALLATION INSTRUCTIONS: here you'll talk about using the `truffle unbox` command, as well as any other set up required to get the box installed] | ||
|
||
```bash | ||
$ truffle unbox [BOX NAME] | ||
``` | ||
### Deployment | ||
|
||
[DEPLOYMENT INSTRUCTIONS: here you might talk about how to deploy your project to mainnet or testnet. Consider using [Truffle Dashboards](https://trufflesuite.com/blog/introducing-truffle-dashboard/) so you don't have to copy and paste your private keys. You can find the Truffle Dashboard documentation [here](https://trufflesuite.com/docs/truffle/getting-started/using-the-truffle-dashboard/)] | ||
|
||
## Usage | ||
|
||
[USAGE INSTRUCTIONS: here you'll talk about how to use your box. This might include anything from common commands or how to test it. Bonus points if you include links to a tutorial on an advanced use case of your box!] | ||
|
||
### Commands | ||
|
||
[COMMANDS AND WHAT THEY DO] | ||
|
||
### Testing | ||
|
||
[TESTING INSTRUCTIONS] | ||
|
||
## Support | ||
|
||
Need help? Get in touch with the Truffle community by posting on [Github Discussions](https://github.com/trufflesuite)! |