docs: minor updates to readme/contributing

Signed-off-by: Richard Case <[email protected]>

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 We highly value and encourage contributions from the community!
 
-Reignite is [Apache 2.0 licensed](LICENCE) and accepts contributions via GitHub
+Reignite is [MPL-2.0 licensed](LICENSE) and accepts contributions via GitHub
 Pull Requests.This document outlines some of the conventions on development
 workflow, commit message formatting, contact points and other resources to make
 it easier to get your contribution accepted.
@@ -14,11 +14,11 @@ We gratefully welcome improvements to documentation as well as to code.
 If you have a feature suggestion or found a bug, head over to
 [GitHub issues][issues] and see if there's an open issue matching your
 description. If not feel free to open a new issue and add short description:
- - In case of a bug, be sure to include the steps you performed and what Reignite responded so it's easy for others to reproduce
- - If you have a feature suggestion, describe it in moderate detail and include some potential uses you see for the feature.
-   We prioritize the features to be implemented based on their
-   usefulness/popularity. Of course if you want to start contributing yourself,
-   go ahead! We'll be more than happy to review your pull requests.
+
+ - In case of a bug, be sure to include the steps you performed and what Reignite responded so it's easy for others to reproduce 
+- If you have a feature suggestion, describe it in moderate detail and include some potential uses you see for the feature.
+
+We prioritize the features to be implemented based on their usefulness/popularity. Of course if you want to start contributing yourself, go ahead! We'll be more than happy to review your pull requests.
 
 The maintainers will add the correct labels/milestones to the issue for you.
 
@@ -33,7 +33,7 @@ The process to contribute code to Reignite is very straightforward.
    personal account.
 2. Using standard `git` workflow, `clone` your fork, make your changes and then
    `commit` and `push` them to your repository.
-3. Run `make generate`, then `commit` and `push` the changes.
+3. Run `make generate && make test && make lint`, then `commit` and `push` the changes.
 4. Go back to [GitHub][repo], select `Pull requests` from the top bar and click
    `New pull request` to the right. Select the `compare across forks` link.
    This will show repositories in addition to branches.

README.md

@@ -1,25 +1,32 @@
-# (Re)Ignite a MicroVM
 
+# 🆁🅴🅸🅶🅽🅸🆃🅴 - the microvm service
+
+[![GitHub](https://img.shields.io/github/license/weaveworks/reignite)](https://img.shields.io/github/license/weaveworks/reignite)
 [![codecov](https://codecov.io/gh/weaveworks/reignite/branch/main/graph/badge.svg?token=ZNPNRDI8Z0)](https://codecov.io/gh/weaveworks/reignite)
+[![Go Report Card](https://goreportcard.com/badge/github.com/weaveworks/reignite)](https://goreportcard.com/report/github.com/weaveworks/reignite)
+
+## What is regnite?
 
-## What is (Re)Ignite?
+Reignite is a service for creating and managing the lifecycle of microVMs on a host machine. Initially we will be supporting [Firecracker](https://firecracker-microvm.github.io/). 
 
-Reignite is a Kubernetes cluster provisioning and manager service on a bare
-metal infrastructure.
+The primary use case for reignite is to create microVMs on a bare-metal host where the microVMs will be used as nodes in a virtualized Kubernetes cluster. It is an essential part of [Liquid Metal](https://www.weave.works/blog/multi-cluster-kubernetes-on-microvms-for-bare-metal) and will ultimately be driven by Cluster API Provider Microvm (coming soon).
 
-## Use-cases
+## Features
 
-* Companies that want to use Kubernetes, but they are tied to their physical
-  servers for technical or legal reasons.
-* ???
+Using API requests (via gRPC or HTTP):
+- Create, update, delete microVMs using Firecracker
+- Manage the lifecycle of microVMs (i.e. start, stop, pause)
+- Make metadata available to microVMs to support cloud-init, ignition etc
+- Use OCI images for the volumes, kernel & initrd
+- (coming soon) Use CNI to configure the network for the microVMs
 
 ## Documentation
 
-* [Getting started with reignite][quickstart]
+See our [getting started with reignite][quickstart] guide.
 
 ## Contributing
 
-Please see [CONTRIBUTING.md][contrib] and our [Code Of Conduct][coc].
+Contributions are welcome. Please read the [CONTRIBUTING.md][contrib] and our [Code Of Conduct][coc].
 
 Other interesting resources include:
 
@@ -38,13 +45,13 @@ Your feedback is always welcome!
 
 ## License
 
-[License 2.0][license]
+[MPL-2.0 License][license]
 
 
-[quickstart]: https://github.com/weaveworks/reignite/blob/main/docs/quick-start.md
-[contrib]: https://github.com/weaveworks/reignite/blob/main/CONTRIBUTING.md
-[coc]: https://github.com/weaveworks/reignite/blob/main/CODE_OF_CONDUCT.md
+[quickstart]: ./docs/quick-start.md
+[contrib]: ./CONTRIBUTING.md
+[coc]: ./CODE_OF_CONDUCT.md
 [issues]: https://github.com/weaveworks/reignite/issues
 [milestones]: https://github.com/weaveworks/reignite/milestones
-[adr]: https://github.com/weaveworks/reignite/tree/main/docs/adr
-[license]: https://github.com/weaveworks/reignite/blob/main/LICENSE
+[adr]: ./docs/adr
+[license]: ./LICENSE