Minor docs updates

aurae-runtime · Jan 29, 2023 · 027cfff · 027cfff
1 parent af23f8d
commit 027cfff
Showing 1 changed file with 12 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 This repository will maintain the releases for the aurae project.
 
-### Project Status
+## Project Status
 
 The project is very young and under active development. The APIs are subject to change without notice until further notice.
 As we continue to develop the project the APIs will stabilize and eventually a long term stable release will be offered.
@@ -11,20 +11,23 @@ At this time the project should not be run in production.
 
 Please read [getting involved](https://aurae.io/community/#getting-involved) if you are interested in joining the project in its early phases. Contribution types of all types and ranges are welcome.
 
-### Release Artifacts
+## Release Artifacts
 
 > Note: some of these links may not function until we release the first build
 
 The following artifacts will be available with every stable build. While we are in alpha, only artifacts that share the same version are known to be compatible.
 
-| Build                                                                           | Repository | Architectures          | Artifacts                                                   | Status                                                                                                                                |
-| ------------------------------------------------------------------------------- | ---------- | ---------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
-| [auraed](https://github.com/aurae-runtime/aurae/tree/main/auraed)               |            | `x86_64-unknown-linux` | [Releases](https://github.com/aurae-runtime/aurae/releases) | ![Main Build](https://github.com/aurae-runtime/aurae/actions/workflows/001-cargo-install-ubuntu-make-build.yml/badge.svg?branch=main) |
-| [auraescript](https://github.com/aurae-runtime/aurae/tree/main/auraescript)     |            | `x86_64-unknown-linux` | [Releases](https://github.com/aurae-runtime/aurae/releases) | ![Main Build](https://github.com/aurae-runtime/aurae/actions/workflows/001-cargo-install-ubuntu-make-build.yml/badge.svg?branch=main) |
-| [aer](https://github.com/aurae-runtime/aurae-runtime/aer/tree/main/auraescript) |            | `x86_64-unknown-linux` | [Releases](https://github.com/aurae-runtime/aurae/releases) | ![Main Build](https://github.com/aurae-runtime/aurae/actions/workflows/001-cargo-install-ubuntu-make-build.yml/badge.svg?branch=main) |
-| [ae](https://github.com/aurae-runtime/ae)                                       |            | `x86_64`               | [Releases](https://github.com/aurae-runtime/ae/releases)    |                                                                                                                                       |
+| Build | Architectures| Artifacts| Status|
+|------------------------------------------------------------------------------- | ---------------------- | -----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------- |
+| [auraed](https://github.com/aurae-runtime/aurae/tree/main/auraed)               | `x86_64-unknown-linux` | [Releases](https://github.com/aurae-runtime/aurae/releases) | ![Main Build](https://github.com/aurae-runtime/aurae/actions/workflows/001-cargo-install-ubuntu-make-build.yml/badge.svg?branch=main) |
+| [auraescript](https://github.com/aurae-runtime/aurae/tree/main/auraescript)     | `x86_64-unknown-linux` | [Releases](https://github.com/aurae-runtime/aurae/releases) | ![Main Build](https://github.com/aurae-runtime/aurae/actions/workflows/001-cargo-install-ubuntu-make-build.yml/badge.svg?branch=main) |
+| [aer](https://github.com/aurae-runtime/aurae-runtime/aer/tree/main/auraescript) | `x86_64-unknown-linux` | [Releases](https://github.com/aurae-runtime/aurae/releases) | ![Main Build](https://github.com/aurae-runtime/aurae/actions/workflows/001-cargo-install-ubuntu-make-build.yml/badge.svg?branch=main) |
+| [ae](https://github.com/aurae-runtime/ae)                                       | `x86_64`               | [Releases](https://github.com/aurae-runtime/ae/releases)    |                                                                                                                                       |
 
-### Support
+## Release Process
+The instructions to cut a release are available in the [RELEASE.md](/RELEASE.md).
+
+## Support
 
 Please check out our [FAQ](#FAQ) section to see if it might help address your issue. Our [website](https://aurae.io/community/) also has information that may help.