Merge pull request #26 from OAK-Foundation/irsal-eng-6-add-gh-workflows

Add GH Workflow Actions + Cleanup README

.github/workflows/check.yml

@@ -1,4 +1,4 @@
-name: Check Set-Up & Build
+name: Check Set-Up, Build, Test
 
 # Controls when the action will run. 
 on:
@@ -13,7 +13,7 @@ on:
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
-  check:
+  check-build:
     # The type of runner that the job will run on
     runs-on: ubuntu-20.04
 
@@ -37,3 +37,25 @@ jobs:
       - name: Check Build
         run: |
           SKIP_WASM_BUILD=1 cargo check --release
+
+  run-tests:
+      runs-on: ubuntu-20.04
+
+      steps:
+        - uses: actions/checkout@v2
+
+        - name: Set-Up
+          run: sudo apt install -y cmake pkg-config libssl-dev git build-essential clang libclang-dev curl
+
+        - name: Install Rustup
+          run: |
+            curl https://sh.rustup.rs -sSf | sh -s -- -y
+            source ~/.cargo/env
+            rustup default stable
+            rustup update nightly
+            rustup update stable
+            rustup target add wasm32-unknown-unknown --toolchain nightly
+        
+        - name: Run Cargo Tests
+          run: |
+            SKIP_WASM_BUILD=1 cargo test

README.md

@@ -5,40 +5,38 @@ Documentation
 ----------
 
 * [Website](https://oak.tech/)
-* [Documentation]()
+* [Documentation](https://docs.oak.tech/)
 
 Community
 --------- 
 
 * General discussion: [Telegram (Coming Soon)]()
-* Technical discussion: [Discord (Coming Soon)]()
-* Subscribe on [OAK Twitter](https://twitter.com/OAKSubstrate)
+* Technical discussion: [Discord](https://discord.gg/7W9UDvsbwh)
+* Subscribe on [OAK Twitter](https://twitter.com/oak_network)
 * Subscribe on [Founder's Twitter](https://twitter.com/chrisli2046)
 
 Table of Contents
 -----------------
 
-* [Introduction]()
-* [Install OAK]()
-* [OAK Validator Program]()
+* [Introduction](https://github.com/OAK-Foundation/OAK-blockchain#introduction)
+* [Install OAK](https://github.com/OAK-Foundation/OAK-blockchain#install-oak-blockchain)
+* [OAK Validator Program](https://github.com/OAK-Foundation/OAK-blockchain/blob/master/docs/validator-setup.md)
 
 Introduction
 ============
 
-**OAK, or Onchain Automation Framework, is equipped with a novel smart contract virtual machine that supports an event-driven execution model, enabling developers to build fully autonomous decentralized application. **By extending the current set of atomic operations, namely, opcodes of EVM, OAK introduces an innovative way for contracts to interact with each other. Contracts can emit signal events, on which other contracts can listen. Once an event is triggered, corresponding handler functions are automatically executed as a new type of transaction, signal transaction. Applications implemented with the new approach will eliminate the dependency of unreliable mechanisms like off-chain relay servers, and in return, to significantly simplify the execution flow of the application and can avoid security risks such as relay manipulation attacks.
+**OAK, or Onchain Automation Framework, is equipped with a novel smart contract virtual machine that supports an event-driven execution model, enabling developers to build fully autonomous decentralized application.** By extending the current set of atomic operations, namely, opcodes of EVM, OAK introduces an innovative way for contracts to interact with each other. Contracts can emit signal events, on which other contracts can listen. Once an event is triggered, corresponding handler functions are automatically executed as a new type of transaction, signal transaction. Applications implemented with the new approach will eliminate the dependency of unreliable mechanisms like off-chain relay servers, and in return, to significantly simplify the execution flow of the application and can avoid security risks such as relay manipulation attacks.
 
 Based on the above, OAK has some features.
-- **[OAK Virtual Machine]()**
-- **[Autonomous Transactions]()**
-- **[Onchain Relayer]()**
-- **[Validator Staking]()**
-
-Once Polkadot is launched, we will connect our root chain to Polkadot, and we aim to be one of the parachains.
+- **OAK Virtual Machine**
+- **Autonomous Transactions**
+- **On-chain Relayer**
+- **Validator Staking**
 
 Install OAK Blockchain 
 =============
 
-* OAK releases [releases]().
+* OAK releases [releases](https://github.com/OAK-Foundation/OAK-blockchain/releases).
 * Node [custom types](). 
 
 > Latest version you can try to build from source.
@@ -75,7 +73,7 @@ Run node on [Dusty Network](https://telemetry.polkadot.io/#list/Dusty):
 
 Or run on your local development network:
 
-    oak --dev
+    ./target/release/oak --dev --tmp
 
 Building with Nix
 -----------------
@@ -97,16 +95,16 @@ Here are the key milestones.
 1. Become a Kusama Parachain (TBA)
 1. Become a Polkadot Parachain. (TBA)
 
-If you have any questions, please ask us on [Discord]()
+If you have any questions, please ask us on [Discord](https://discord.gg/7W9UDvsbwh)
 
 Contacts
 --------
 
 **Maintainers**
 
 * [Chris Li](https://github.com/chrisli30)
-* [Xingyou Chen](https://github.com/imstar15)
-* [Zhongwei Shi](https://github.com/amazingbeerbelly)
+* [Irsal McGinnis](https://github.com/irsal)
+* [Charles Chen](https://github.com/imstar15)
 
 * * *