[chore] Update doc

snapshot-labs · Apr 19, 2023 · 5ec7296 · 5ec7296
1 parent 6dd0d24
commit 5ec7296
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 4 deletions.
diff --git a/.env.example b/.env.example
@@ -1 +1 @@
-HUB_URL=https://snapshot.org
+HUB_URL=https://hub.snapshot.org
diff --git a/README.md b/README.md
@@ -12,12 +12,22 @@ for snapshot-hub, for proposals' votes.
 
 ## Project Setup
 
-> yarn
+### Dependencies
 
-Set the hub API url in the `.env` file
+Install the dependencies
 
 ```
-HUB_URL=
+yarn
+```
+
+_This project does not require a database, but may need larger server storage capacity for the cached files_
+
+### Configuration
+
+Edit the hub API url in the `.env` file if needed
+
+```
+HUB_URL=https://hub.snapshot.org
 ```
 
 ## Compiles and hot-reloads for development
@@ -33,6 +43,13 @@ yarn lint
 yarn typecheck
 ```
 
+## Build for production
+
+```
+yarn build
+yarn start
+```
+
 ## License
 
 [MIT](https://github.com/snapshot-labs/envelop-ui/blob/bootstrap-app/LICENSE)
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		HUB_URL=https://snapshot.org
		HUB_URL=https://hub.snapshot.org