From cb45e3309c51ccb0e9dbe9162b1681a382058b3a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Felix=20Quei=C3=9Fner?= <felix@ib-queissner.de>
Date: Sat, 10 Feb 2024 13:29:43 +0100
Subject: [PATCH] Update README.md

---
 README.md | 45 ++++++++++++++++++++++++++++++++++++---------
 1 file changed, 36 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index be972eb..9f594a3 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,48 @@
-![MicroZig Logo](design/logo-text-auto.svg)
+# ![MicroZig Logo](design/logo-text-auto.svg)
 
+[![Chat](https://img.shields.io/discord/824493524413710336.svg?logo=discord)](link=https://discord.gg/ShUWykk38X)
+[![Downloads](https://img.shields.io/badge/Zig_Package-Download-blue)](https://downloads.microzig.tech/)
 [![Continuous Integration](https://github.com/ZigEmbeddedGroup/microzig-monorepo/actions/workflows/build.yml/badge.svg)](https://github.com/ZigEmbeddedGroup/microzig-monorepo/actions/workflows/build.yml)
 
-## Overview
+> **NOTE:** This is in development; breaks in the API are bound to happen.
+
+## What version of Zig to use
+
+0.11.0
+
+## Contributing
+
+Please see the [project page](https://github.com/orgs/ZigEmbeddedGroup/projects/1/views/1), it’s used as a place to brainstorm and organize work in ZEG. There will be issues marked as good first issue or drafts for larger ideas that need scoping/breaking ground on.
+
+## Introduction
+
+This repo contains the infrastructure for getting started in an embedded Zig project; it "gets you to main()". Specifically, it offers:
+
+* a single easy-to-use builder function that:
+  * generates your linker script
+  * sets up packages and startup code
+* generalized interfaces for common devices, such as UART.
+* device drivers for interacting with external hardware
+* an uncomplicated method to define xref:interrupts[interrupts]
+
+## Getting Started
+
+Search for your chip family in [the examples](https://downloads.microzig.tech/examples/) and get the archive.
+
+You can easily get started based on that.
+
+## Design
+
+For MicroZig internals please see the [Design Document](docs/design.adoc).
+
+## Repository structure
 
 - `build/` contains the build components of MicroZig.
 - `core/` contains the shared components of MicroZig.
 - `board-support/` contains all official board support package.
 - `examples/` contains examples that can be used with the board support packages.
 - `tools/` contains tooling to work *on* MicroZig itself, so deployment, testing, ...
+- `design/` contains images and logos
 
 ## Versioning Scheme
 
@@ -21,10 +55,3 @@ As MicroZig sticks to tagged Zig releases, `${zig_version}` will show to which Z
 
 Consider the version `0.11.0-abcdef-123` means that this MicroZig version has a commit starting with `abcdef`, which was the 123rd commit of the version that is compatible with Zig 0.11.0.
 
-## TODO (before exchanging upstream)
-
-- Integrate https://github.com/ZigEmbeddedGroup/microzig-driver-framework as package
-- Create support for nice GitHub badges
-- validate that the table on https://github.com/ZigEmbeddedGroup is correct (in CI)
-- start porting everything to 0.12/unstable
-- Try to get some autodocs to build.