From 874fb37796e5c87989d5ab00d5eaf3bf986b8422 Mon Sep 17 00:00:00 2001
From: piotr-iohk <42900201+piotr-iohk@users.noreply.github.com>
Date: Wed, 4 Dec 2024 19:14:52 +0100
Subject: [PATCH] Documentation and readme (#80)

---
 README.md | 64 +++++++++++++++++++++++--------------------------------
 1 file changed, 27 insertions(+), 37 deletions(-)

diff --git a/README.md b/README.md
index 0becdbf..05819a8 100644
--- a/README.md
+++ b/README.md
@@ -1,57 +1,47 @@
-# Mina Mesh
+<div align="center">
+
+[![checks](https://github.com/MinaFoundation/MinaMesh/actions/workflows/checks.yaml/badge.svg)](https://github.com/MinaFoundation/MinaMesh/actions/workflows/checks.yaml)
+[![Crates.io](https://img.shields.io/crates/v/mina_mesh?label=crates.io&color=blue)](https://crates.io/crates/mina_mesh/versions)
+[![Downloads](https://img.shields.io/crates/d/mina_mesh?color=green)](https://crates.io/crates/mina_mesh)
+![License](https://img.shields.io/badge/license-Apache%202.0-blue)
+
+# **Mina Mesh**
 
 Mina Mesh is an implementation of the
 [Coinbase Mesh specification](https://docs.cdp.coinbase.com/mesh/docs/welcome) for the
 [Mina blockchain](https://minaprotocol.com/).
 
-> Note: Mina Mesh is WIP and should not yet be used in production.
-
-## Installation
-
-Ensure you have the Rust toolchain installed. If you do not, see
-[installation instructions here](https://www.rust-lang.org/tools/install).
+🚧 _**Note:** Mina Mesh is a work in progress (WIP) and should not yet be used in production._
 
-```sh
-# Install
-cargo install mina_mesh@0.1.0-beta.1
+</div>
 
-# Confirm installation
-mina-mesh --help
-```
+---
 
-> Note: the version specifier is necessary when installing from the `beta` release channel. The
-> latest version can be found on
-> [`mina_mesh`'s crates.io page](https://crates.io/crates/mina_mesh/versions).
+## **Documentation**
 
-## Environment
+Looking to get started? Check out the
+**[Mina Mesh Wiki](https://github.com/MinaFoundation/MinaMesh/wiki)** for:
 
-The server depends on several environment variables.
+- Installation instructions
+- Configuration details
+- Usage examples
 
-- `MINAMESH_PROXY_URL`: a Mina proxy (GraphQL) endpoint. The default is
-  `https://mainnet.minaprotocol.network/graphql`.
-- `MINAMESH_ARCHIVE_DATABASE_URL`: a connection string referencing a Mina archive database.
+---
 
-## Instantiate the Server
+## **Code of Conduct**
 
-```sh
-mina-mesh serve --playground
-```
+Please ensure you adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) when interacting in this
+repository.
 
-> Note: the presence of the `--playground` flag enables the serving of an OpenAPI playground in
-> response to `GET /`. To disable this endpoint, omit the `--playground` flag.
+---
 
-Visit [`http://0.0.0.0:3000`](http://0.0.0.0:3000) for an interactive playground with which you can
-explore and test endpoints.
-
-## Code of Conduct
-
-Everyone interacting in this repo is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
-
-## Contributing
+## **Contributing**
 
 Contributions are welcome and appreciated! Check out the [contributing guide](CONTRIBUTING.md)
 before you dive in.
 
-## License
+---
+
+## **License**
 
-Mina Mesh is [Apache licensed](LICENSE).
+Mina Mesh is licensed under the [Apache License 2.0](LICENSE).