added README.md + github ci workflows #1

	---
	name: Release worfklow

	concurrency:
	group: ${{ github.workflow }}-${{ github.ref }}
	cancel-in-progress: true

	# This is needed if we are using github enterprise.
	permissions:
	contents: write
	pull-requests: write
	id-token: write

	on:
	push:
	workflow_dispatch:

	env:
	CARGO_TERM_COLOR: always

	jobs:
	release:
	strategy:
	matrix:
	os: [ubuntu-22.04]
	runs-on: [self-hosted, "${{ matrix.os }}", baremetal]
	steps:
	- name: Checkout repo
	uses: actions/checkout@v4

	- name: Set cargo
	uses: dtolnay/[email protected]

	- name: Clear rust cache
	run: \|
	cargo cache -r all

	- name: Set build cargo cache
	uses: actions/cache@v4
	with:
	path: \|
	~/.cargo/bin/
	~/.cargo/registry/index/
	~/.cargo/registry/cache/
	~/.cargo/git/db/
	fumarole/${{ matrix.os }}
	key: ${{ matrix.os }}_fumarole_${{ hashFiles('**/Cargo.lock') }}
	restore-keys: \|
	${{ matrix.os }}_fumarole

	- name: Cargo fmt
	if: startsWith(github.ref, 'refs/tags/') != true
	run: cargo +nightly fmt --all -- --check

	- name: Cargo clippy
	if: startsWith(github.ref, 'refs/tags/') != true
	run: cargo clippy --workspace --all-targets --tests

	- name: Cargo deny check advisories
	if: startsWith(github.ref, 'refs/tags/') != true
	uses: EmbarkStudios/cargo-deny-action@v1
	with:
	command: check advisories

	- name: Cargo check the entire project
	if: startsWith(github.ref, 'refs/tags/') != true
	run: cargo check --all-targets --tests --all-features

	- name: Set PROTOC environment variable in order to build
	run: echo "PROTOC=/usr/bin/protoc" >> $GITHUB_ENV

Provide feedback