From 945f3ed1303580d89008e278060d53a3f11bf84b Mon Sep 17 00:00:00 2001
From: rilaxik <dev.rilaxik@gmail.com>
Date: Fri, 14 Jun 2024 17:36:27 +0000
Subject: [PATCH] intro + shared types

---
 Docs.md | 35 ++++++++++++++++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/Docs.md b/Docs.md
index 5d08b7b..aa054a3 100644
--- a/Docs.md
+++ b/Docs.md
@@ -1 +1,34 @@
-Welcome to the Wiki.
\ No newline at end of file
+> RageFW and it's documentation is still in early development and may contain come unclear explanations. It you find any of those please open an issue and describe you problem or any improvemenets you want to see
+
+RageFW distibutes under a list of packages: 
+- ``rage-fw-server``
+- ``rage-fw-client``
+- ``rage-fw-cef``
+- ``rage-fw-shared-types``
+
+These are setup as-should if you are using our CLI, if you still want to setup yourself, please refer to [example](https://git.entityseven.com/entityseven/rage-framework-example)
+
+## Shared types
+Core element of type-safety in our framework system. It allows you to manually type any **custom** events you have in your server system. 
+There are three interfaces, which share between the system to apply types: 
+- ``RageFW_ICustomClientEvent``
+- ``RageFW_ICustomServerEvent``
+- ``RageFW_ICustomCefEvent``
+
+To apply types for events we use the following system and below is a sample how it applies them your code
+
+```ts
+customEventName(arg1: string, arg2: number): boolean
+```
+```ts
+register('customEventName', (arg1 /*string*/, arg2 /*number*/) => {
+  // your logic
+return true /*boolean*/
+})
+```
+
+## Server
+
+## Client 
+
+## CEF
\ No newline at end of file