Update README.md

Added the baseline readme stuff
2026-05-13 12:45:47 +00:00 · 2024-03-01 11:54:22 +01:00
parent cae726321a
commit 13211e4b56
1 changed files with 26 additions and 1 deletions
@@ -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*
+