From c67ad4bdf2d4a5cd1f4bd1e95046f469a41b159f Mon Sep 17 00:00:00 2001
From: Stefan Galler <galler.stefan@gmail.com>
Date: Thu, 3 Oct 2024 07:51:28 +0200
Subject: [PATCH] update readme

---
 README.md | 29 +++++++++++++++++++++++++++--
 1 file changed, 27 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index aa17211..67476a2 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,28 @@
-# src
+# Flutter JWT Auth
 
-A new Flutter project.
+This project showcases a simple implementation of JWT auth in Flutter.
+
+A detailed explanation of the implementation can be found on bettercoding.dev.
+
+## Server
+
+This project provides a simple test server that implements basic JWT auth endpoints.
+See https://github.com/bettercoding-dev/shelf-jwt-test-server for more details.
+
+To start the server in this project, simple run:
+
+```shell
+dart server/shelf-jwt-test-server/bin/server.dart
+```
+
+## Follow-Along
+
+If you want to implement certain parts of the project yourself to improve your coding skills, you can
+check out the `follow-along` branch.
+
+```shell
+git checkout follow-along
+```
+
+In this branch, I removed certain parts of the implementation, and you can code it yourself with the help of the
+tutorial.