From 13211e4b56ccea641883698b3d1c6824d0a29f18 Mon Sep 17 00:00:00 2001
From: Theis <112340858+Slug-Boi@users.noreply.github.com>
Date: Fri, 1 Mar 2024 11:54:22 +0100
Subject: [PATCH] Update README.md

Added the baseline readme stuff
---
 README.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d88c004..fe79b2c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,27 @@
 # cocommit
-This is the home of the cocommit programs and all their varations
+Currently built in:
+- [x] Go
+- [ ] C++
+- [ ] Python
+
+Currently tested in:
+- [ ] Go
+- [ ] C++
+- [ ] Python
+
+# How to run
+*Coming soon*
+
+# Syntax for the author file
+The syntax for the author file can be found at the top of the template file included in the repo. It should look like this:
+```
+name_short|Name|Username|emai
+```
+
+# Why?
+Writing co-authors onto commits can be pretty tedious so automating this process as a simple shell alias is a lot nicer
+
+# Workflows
+This repo is sort of a test bed for working with Dagger CI but therefore also should support automated testing and building at some point 
+*coming soon*
+