Add documentation for quick-bootstrap.sh
This commit is contained in:
parent
ac7802f158
commit
2295a9df06
1 changed files with 18 additions and 1 deletions
|
@ -82,6 +82,23 @@ case $1 in
|
|||
echo "=================================================="
|
||||
echo "You look like you need usage examples let me help."
|
||||
echo "=================================================="
|
||||
echo "Add documentation on script params HERE"
|
||||
echo "./quick-boostrap.sh {Parameter}"
|
||||
echo "Example: ./quick-bootstrap.sh getdata # Downloads the latest Chainquery checkpoint data from a LBRYio official aws instance."
|
||||
echo ""
|
||||
echo ""
|
||||
echo "=================================================="
|
||||
echo "Usage example and available parameters"
|
||||
echo "=================================================="
|
||||
echo ""
|
||||
echo "getdata # This function grabs the latest Chainquery checkpoint data."
|
||||
echo "extract # Unpacks the chainquery data into the correct directory. ./data/"
|
||||
echo "cleanup # Removes chainquery.zip"
|
||||
echo "reset # Reset the state of these containers entirely, use if all else fails."
|
||||
echo ""
|
||||
echo ""
|
||||
echo "=================================================="
|
||||
echo "=================================================="
|
||||
echo "Any other functions that are not documented here are not intended for public use."
|
||||
echo " These functions are included in this repository to keep things in one place."
|
||||
;;
|
||||
esac
|
||||
|
|
Loading…
Reference in a new issue