diff --git a/README.md b/README.md index a0ff4d44b..9dfbd4718 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ # okp4 + **okp4** is a blockchain built using Cosmos SDK and Tendermint and created with [Starport](https://starport.com). ## Get started -``` +```sh starport chain serve ``` @@ -17,7 +18,7 @@ Your blockchain in development can be configured with `config.yml`. To learn mor Starport has scaffolded a Vue.js-based web app in the `vue` directory. Run the following commands to install dependencies and start the app: -``` +```sh cd vue npm install npm run serve @@ -26,9 +27,10 @@ npm run serve The frontend app is built using the `@starport/vue` and `@starport/vuex` packages. For details, see the [monorepo for Starport front-end development](https://github.com/tendermint/vue). ## Release + To release a new version of your blockchain, create and push a new tag with `v` prefix. A new draft release with the configured targets will be created. -``` +```sh git tag v0.1 git push origin v0.1 ``` @@ -36,11 +38,13 @@ git push origin v0.1 After a draft release is created, make your final changes from the release page and publish it. ### Install + To install the latest version of your blockchain node's binary, execute the following command on your machine: -``` +```sh curl https://get.starport.com/okp4/okp4@latest! | sudo bash ``` + `okp4/okp4` should match the `username` and `repo_name` of the Github repository to which the source code was pushed. Learn more about [the install process](https://github.com/allinbits/starport-installer). ## Learn more