diff --git a/README.md b/README.md index a7731da..ff51dc4 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,47 @@ -

ThreeFold DePIN Board

+

ThreeFold DePIN Cloud Website

+

Table of Contents

-to run in development mode +- [Introductiona](#introductiona) +- [Install Hero](#install-hero) +- [Deploy Locally](#deploy-locally) +- [Push Changes](#push-changes) +- [URL](#url) + +--- + +## Introductiona + +This repository contains the code to deploy the ThreeFold DePIN Cloud website. + +## Install Hero ```bash -#first time to get hero curl https://raw.githubusercontent.com/freeflowuniverse/herolib/refs/heads/development/install_hero.sh > /tmp/install_hero.sh bash /tmp/install_hero.sh -#DONT FORGET TO START A NEW SHELL (otherwise the paths will not be set) +``` +## Deploy Locally + +You can run the website in your development environment on a local browser. Make sure to start a new shell if you've just installed Hero. + +``` hero docusaurus -u https://git.ourworld.tf/tfgrid/docs_depin -d ``` -to push +## Push Changes -```bash -hero docusaurus -u https://git.ourworld.tf/tfgrid/docs_depin -bp -update +- Development + ``` + hero docusaurus -u https://git.ourworld.tf/tfgrid/docs_depin -bpd + ``` +- Production -#push for development: -hero docusaurus -u https://git.ourworld.tf/tfgrid/docs_depin -bpd -update -``` + ```bash + hero docusaurus -u https://git.ourworld.tf/tfgrid/docs_depin -bp + ``` ## URL -- The production website is available at `https://threefold.info/depin` +- The website in staging mode is at https://dev.threefold.info/depin +- The website in production mode is at https://threefold.info/depin \ No newline at end of file