refactor: move okp4 content to project root

.github/workflows/release.yml

@@ -0,0 +1,53 @@
+# This workflow is useful if you want to automate the process of:
+#
+# a) Creating a new prelease when you push a new tag with a "v" prefix (version).
+#
+#    This type of prerelease is meant to be used for production: alpha, beta, rc, etc. types of releases.
+#    After the prerelease is created, you need to make your changes on the release page at the relevant
+#    Github page and publish your release.
+#
+# b) Creating/updating the "latest" prerelease when you push to your default branch.
+#
+#    This type of prelease is useful to make your bleeding-edge binaries available to advanced users.
+#
+# The workflow will not run if there is no tag pushed with a "v" prefix and no change pushed to your 
+# default branch.
+on: push
+
+jobs:
+  might_release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Prepare Release Variables 
+        id: vars
+        uses: tendermint/starport/actions/release/vars@develop
+
+      - name: Issue Release Assets 
+        uses: tendermint/starport/actions/cli@develop
+        if: ${{ steps.vars.outputs.should_release == 'true' }}
+        with:
+          args: chain build --release --release.prefix ${{ steps.vars.outputs.tarball_prefix }} -t linux:amd64 -t darwin:amd64
+
+      - name: Delete the "latest" Release
+        uses: dev-drprasad/[email protected]
+        if: ${{ steps.vars.outputs.is_release_type_latest == 'true' }}
+        with:
+          tag_name: ${{ steps.vars.outputs.tag_name }}
+          delete_release: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Publish the Release
+        uses: softprops/action-gh-release@v1
+        if: ${{ steps.vars.outputs.should_release == 'true' }}
+        with:
+          tag_name: ${{ steps.vars.outputs.tag_name }}
+          files: release/*
+          prerelease: true 
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1 +1,6 @@
+vue/node_modules
+vue/dist
+release/
+.idea/
 .vscode/
+.DS_Store

README.md

@@ -1,5 +1,52 @@
-# Template project
+# okp4
+**okp4** is a blockchain built using Cosmos SDK and Tendermint and created with [Starport](https://starport.com).
 
-> Template for opensource projects [@okp4](okp4.com).
+## Get started
 
-[![conventional commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
+```
+starport chain serve
+```
+
+`serve` command installs dependencies, builds, initializes, and starts your blockchain in development.
+
+### Configure
+
+Your blockchain in development can be configured with `config.yml`. To learn more, see the [Starport docs](https://docs.starport.com).
+
+### Web Frontend
+
+Starport has scaffolded a Vue.js-based web app in the `vue` directory. Run the following commands to install dependencies and start the app:
+
+```
+cd vue
+npm install
+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.
+
+```
+git tag v0.1
+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:
+
+```
+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
+
+- [Starport](https://starport.com)
+- [Tutorials](https://docs.starport.com/guide)
+- [Starport docs](https://docs.starport.com)
+- [Cosmos SDK docs](https://docs.cosmos.network)
+- [Developer Chat](https://discord.gg/H6wGTY8sxw)