fix: improve documentation and add README #29

	name: build-test

	on:
	push:
	branches: [ main ]
	pull_request:
	branches: [ main ]

	env:
	CARGO_TERM_COLOR: always

	jobs:
	# [req:qa.pipeline.1_style]
	format:
	name: Check Formatting
	runs-on: ubuntu-latest

	steps:
	- uses: actions/checkout@v2
	- name: Run cargo fmt
	run: cargo fmt -- --check

	# [req:qa.pipeline.2_lint]
	lint:
	name: Run Linter (clippy)
	runs-on: ubuntu-latest
	# [req:qa.sustain]
	needs: format

	steps:
	- uses: actions/checkout@v2
	- name: Run linter
	run: cargo clippy -- -D warnings

	# [req:qa.pipeline.3_build]
	build:
	name: Run Build
	runs-on: ubuntu-latest
	# [req:qa.sustain]
	needs: lint

	steps:
	- uses: actions/checkout@v2
	- name: Build
	run: cargo build --verbose

	# [req:qa.pipeline.4_tests]
	test:
	name: Run Tests
	runs-on: ubuntu-latest
	# [req:qa.sustain]
	needs: build

	steps:
	- uses: actions/checkout@v2
	- name: Run tests
	# Sequential testing required since events are processed by global publisher
	run: cargo test --verbose -- --test-threads 1

Provide feedback