From 7df24540b68c99b5b3fa966e551e566270adb734 Mon Sep 17 00:00:00 2001
From: Marcin Rataj <lidel@lidel.org>
Date: Fri, 14 Oct 2022 17:36:41 +0200
Subject: [PATCH 1/2] docs: add basic readme

---
 README.md | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index e6d9a93..b272a71 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,21 @@
-Repository Name
+go-delegated-routing
 =======================
-Documentation is needed in this Readme, but in the meantime this blog post is a good starting point: https://blog.ipfs.tech/2022-09-02-introducing-reframe/
+
+> Delegated routing Client and Server over Reframe RPC
+
+This package provides delegated routing implementation in Go:
+- Client (for IPFS nodes like [Kubo](https://github.com/ipfs/kubo/blob/master/docs/config.md#routingrouters-parameters)),
+- Server (for public indexers such as https://cid.contact)
 
 ## Documentation
 
-[Insert link to documentation]() or expand with Install, Build, Usage sections.
+- Go docs: https://pkg.go.dev/github.com/ipfs/go-delegated-routing
+- What is Reframe? https://blog.ipfs.tech/2022-09-02-introducing-reframe/
+  - Reframe Specs: https://github.com/ipfs/specs/blob/main/reframe/
 
 ## Lead Maintainer
 
-[Your name](https://github.com/alinktoyourname)
+🦗🎶
 
 ## Contributing
 

From c01abddc3d1ad3d59fdd65b699b3509bf6b758a6 Mon Sep 17 00:00:00 2001
From: Marcin Rataj <lidel@lidel.org>
Date: Fri, 14 Oct 2022 19:18:36 +0200
Subject: [PATCH 2/2] docs: generating client/server

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index b272a71..eb709c3 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,14 @@ This package provides delegated routing implementation in Go:
 
 🦗🎶
 
+## Generating
+
+Client and Server code can be (re-)generated via:
+
+```console
+go generate -v ./...
+```
+
 ## Contributing
 
 Contributions are welcome! This repository is part of the IPFS project and therefore governed by our [contributing guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md).