diff --git a/README.md b/README.md index b25daf6..abf2d20 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ > **_NOTE:_** Fixing documentation to lastest changes ,If you have any questions setting up P2PRC either create an issue or send me an email (me AT akilan dot io). -> Currently HEAD is alaways intended to stay on a working state. It is recommended to alaways use HEAD in your go.mod file. +> Currently HEAD is always intended to stay on a working state. It is recommended to always use HEAD in your go.mod file.


p2prc @@ -24,7 +24,7 @@ flexibility on tracking the container's usages and killing the containers at any
-## Table of contents +## Table of contents in the current README 1. [Introduction](#Introduction) 2. [Installation](#extend-your-application-with-p2prc) 3. [Design Architecture](#Design-Architecture) @@ -33,6 +33,25 @@ flexibility on tracking the container's usages and killing the containers at any
+# Table of contents in the Docs folder +1. [Introduction](Docs/Introduction.md) +2. [Installation](Docs/Installation.md) +3. [Abstractions](Docs/Abstractions.md) + +4. [Implementation](Docs/Implementation.md) + 1. [Client Module](Docs/ClientImplementation.md) + 2. [P2P Module](Docs/P2PImplementation.md) + 3. [Server Module](Docs/ServerImplementation.md) + 4. [Config Module](Docs/ConfigImplementation.md) + 5. [Cli Module](Docs/CliImplementation.md) + 6. [Plugin Module](Docs/PluginImplementation.md) + + +
+ ## Introduction This project aims to create a peer to peer (p2p) network, where a user can use the p2p network to act as a client (i.e sending tasks) or the server (i.e executing the tasks). A prototype application will be developed, which comes bundled with a p2p module and possible to execute docker containers or virtual environments across selected nodes.