Add logo to readme and start writing instructions

sourcebot-dev · Sep 7, 2024 · c8cd4a6 · c8cd4a6
1 parent 19b36e5
commit c8cd4a6
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 1 deletion.
diff --git a/.github/images/logo.png b/.github/images/logo.png
diff --git a/README.md b/README.md
@@ -1 +1,26 @@
-# Sourcebot
+
+<div align="center">
+    <img 
+        src=".github/images/logo.png"
+        width="80%"
+        height="80%"
+    />
+</div>
+
+
+## About
+todo
+
+## Getting Started
+
+1. Clone the repo
+```sh
+   git clone https://github.com/TaqlaAI/sourcebot.git
+```
+
+2. 
+
+Run the image from github
+```sh
+    docker run -d -p 3000:3000 --name sourcebot -v $(pwd):/data ghcr.io/taqlaai/sourcebot:main
+```