Merge pull request #18 from airchains-network/releases/v0.2.0

docs: add instructions for downloading the correct binary based on OS

Author: ComputerKeeda

Makefile

@@ -1,7 +1,7 @@
 # Makefile for building and linting Go project
 
 # Basic project settings
-BINARY_NAME=junction-jip-2
+BINARY_NAME=junctiond
 BUILD_DIR=./build
 SOURCE_DIR=./cmd/junctiond
 CHECKSUM_FILE=$(BUILD_DIR)/checksums.txt
@@ -76,13 +76,13 @@ build-all: go.sum
 	rm -f $(CHECKSUM_FILE)
 	GOOS=linux GOARCH=amd64 $(GO_BUILD) -tags "$(build_tags)" -ldflags '$(ldflags)' -o $(BUILD_DIR)/$(BINARY_NAME)-linux-amd64 $(SOURCE_DIR)
 	@shasum -a 256 $(BUILD_DIR)/$(BINARY_NAME)-linux-amd64 >> $(CHECKSUM_FILE)
-#	GOOS=linux GOARCH=arm64 $(GO_BUILD) -tags "$(build_tags)" -ldflags '$(ldflags)' -o $(BUILD_DIR)/$(BINARY_NAME)-linux-arm64 $(SOURCE_DIR)
-#	@shasum -a 256 $(BUILD_DIR)/$(BINARY_NAME)-linux-arm64 >> $(CHECKSUM_FILE)
-#	GOOS=darwin GOARCH=amd64 $(GO_BUILD) -tags "$(build_tags)" -ldflags '$(ldflags)' -o $(BUILD_DIR)/$(BINARY_NAME)-darwin-amd64 $(SOURCE_DIR)
-#	@shasum -a 256 $(BUILD_DIR)/$(BINARY_NAME)-darwin-amd64 >> $(CHECKSUM_FILE)
-#	GOOS=darwin GOARCH=arm64 $(GO_BUILD) -tags "$(build_tags)" -ldflags '$(ldflags)' -o $(BUILD_DIR)/$(BINARY_NAME)-darwin-arm64 $(SOURCE_DIR)
-#	@shasum -a 256 $(BUILD_DIR)/$(BINARY_NAME)-darwin-arm64 >> $(CHECKSUM_FILE)
-#	GOOS=windows GOARCH=amd64 $(GO_BUILD) -tags "$(build_tags)" -ldflags '$(ldflags)' -o $(BUILD_DIR)/$(BINARY_NAME)-windows-amd64.exe $(SOURCE_DIR)
-#	@shasum -a 256 $(BUILD_DIR)/$(BINARY_NAME)-windows-amd64.exe >> $(CHECKSUM_FILE)
+	GOOS=linux GOARCH=arm64 $(GO_BUILD) -tags "$(build_tags)" -ldflags '$(ldflags)' -o $(BUILD_DIR)/$(BINARY_NAME)-linux-arm64 $(SOURCE_DIR)
+	@shasum -a 256 $(BUILD_DIR)/$(BINARY_NAME)-linux-arm64 >> $(CHECKSUM_FILE)
+	GOOS=darwin GOARCH=amd64 $(GO_BUILD) -tags "$(build_tags)" -ldflags '$(ldflags)' -o $(BUILD_DIR)/$(BINARY_NAME)-darwin-amd64 $(SOURCE_DIR)
+	@shasum -a 256 $(BUILD_DIR)/$(BINARY_NAME)-darwin-amd64 >> $(CHECKSUM_FILE)
+	GOOS=darwin GOARCH=arm64 $(GO_BUILD) -tags "$(build_tags)" -ldflags '$(ldflags)' -o $(BUILD_DIR)/$(BINARY_NAME)-darwin-arm64 $(SOURCE_DIR)
+	@shasum -a 256 $(BUILD_DIR)/$(BINARY_NAME)-darwin-arm64 >> $(CHECKSUM_FILE)
+	GOOS=windows GOARCH=amd64 $(GO_BUILD) -tags "$(build_tags)" -ldflags '$(ldflags)' -o $(BUILD_DIR)/$(BINARY_NAME)-windows-amd64.exe $(SOURCE_DIR)
+	@shasum -a 256 $(BUILD_DIR)/$(BINARY_NAME)-windows-amd64.exe >> $(CHECKSUM_FILE)
 
 .PHONY: default build install test clean lint print-system build-all

README.md

@@ -9,26 +9,50 @@ Welcome to the new version of Junction, a cutting-edge settlement layer that coo
 - Integration of the `trackgate` module for seamless integration with external sequencer support.
 - Incorporation of Espresso sequencer for improved transaction ordering and significantly enhancing overall system functionality.
 
+Download the Correct Binary
+---------------------------
 
-## Installation & Initialization
+Before starting, ensure that you download the appropriate binary for your operating system:
 
-```bash
-wget https://github.com/airchains-network/junction/releases/download/v0.2.0/junctiond
+1.  Visit the [release page](https://github.com/airchains-network/junction/releases/tag/v0.2.0) and download the correct binary for your OS:
+
+    -   **Linux**: `junctiond-linux-amd64`
+    -   **macOS**: `junctiond-darwin-amd64`
+    -   **Windows**: `junctiond-windows-amd64`
+2.  After downloading the binary, rename it to `junctiond`:
+
+```shell
+mv <downloaded-binary> junctiond
+```
+
+3. Make it executable:
+
+```shell
 chmod +x junctiond
+```
+
+4. Move it to your local binary path:
+
+```shell
 sudo mv junctiond /usr/local/bin
 ```
-```bash
+
+Installation & Initialization
+-----------------------------
+
+```shell
 junctiond init <moniker> --chain-id junction --default-denom amf
 ```
 
 ### Start Junction
 
-```bash
+```shell
 junctiond start
 ```
 
-## Additional Information
+Additional Information
+----------------------
 
-For detailed instructions, configurations, and updates, refer to the [docs]("https://docs.airchains.io"). Stay connected with our community for the latest developments and support.
+For detailed instructions, configurations, and updates, refer to the [docs](https://docs.airchains.io). Stay connected with our community for the latest developments and support.
 
-Thank you for your continued support of the Airchains ecosystem. We look forward to a successful and smooth upgrade, bringing enhanced scalability and efficiency to our network through the integration of the Trackgate Module and incorporating the Espresso sequencer.
+Thank you for your continued support of the Airchains ecosystem. We look forward to a successful and smooth upgrade, bringing enhanced scalability and efficiency to our network through the integration of the Trackgate Module and incorporating the Espresso sequencer.