doc(main): Added documentation

ankorstore · Jan 12, 2024 · 058f80b · 058f80b
1 parent 480bebb
commit 058f80b
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -12,13 +12,13 @@
 
 ## Documentation
 
-Yokai's documentation will be available soon.
+See [Yokai documentation](https://ankorstore.github.io/yokai).
 
 ## Fx Modules
 
 Yokai is using [Fx](https://github.com/uber-go/fx) for its plugin system.
 
-Yokai's `Fx modules` are the plugins for your Yokai application.
+Yokai `Fx modules` are the plugins for your Yokai application.
 
 | Fx Module                      | Description                                                             |
 |--------------------------------|-------------------------------------------------------------------------|
@@ -37,7 +37,7 @@ They can also be used in any [Fx](https://github.com/uber-go/fx) based Go applic
 
 ## Modules
 
-Yokai's `modules` are the foundation of the framework.
+Yokai `modules` are the foundation of the framework.
 
 | Module                     | Description                                                                                                                                             |
 |----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|

diff --git a/docs/index.md b/docs/index.md
@@ -1,5 +1,5 @@
-# Introduction
+![Image title](assets/images/yokai.png)
 
-![Image title](assets/images/yokai.png){ align=right }
+# Overview
 
 This documentation compiles all the essential information for building applications using [Yokai](https://github.com/ankorstore/yokai).