docs: readme and typedoc

.github/workflows/build.yml

@@ -58,3 +58,12 @@ jobs:
           cd ../../examples/canvas
           yarn install --frozen-lockfile
           yarn build
+
+  build-docker-image:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - shell: bash
+        run: |
+          docker compose build 
+

README.md

@@ -1,2 +1,64 @@
 # ts-topology
 The official TypeScript implementation of Topology Protocol
+
+## Introducion
+
+## Development
+
+To build and run this project you'll need to have [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable) installed.
+If you don't have yarn installed, go ahead and install the latest version.
+
+### Build Project
+Install the dependecies of every package of the project.
+
+```sh
+
+# build crdt
+> cd packages/crdt
+> yarn install
+> yarn build
+
+# build network
+> cd packages/network
+> yarn install
+> yarn build
+
+# build node
+> cd packages/node
+> yarn install
+> yarn build
+
+# build object
+> cd packages/objects
+> yarn install
+> yarn build
+
+# build examples-canvas
+> cd packages/examples/canvas
+> yarn install
+> yarn build
+
+```
+
+### Run Project
+To run the exemple-canvas execute:
+
+```sh
+
+>cd examples/canvas
+# this will execute "webpack serve" 
+> yarn dev
+
+```
+
+This command will create a development server for the project at http://localhost:3000/.
+
+
+
+## Example
+For a better undestandability of this project we explain using an example.
+
+
+
+
+

package.json

@@ -23,7 +23,8 @@
     "vitest": "^1.6.0"
   },
   "workspaces": [
-    "packages/*"
+    "packages/*",
+    "examples/*"
   ],
   "private": true,
   "release-it": {