From c646a1389e64df9ad6fbbf7b1b987b18adfac748 Mon Sep 17 00:00:00 2001 From: Akilan Date: Wed, 22 Feb 2023 23:08:11 +0000 Subject: [PATCH] added other abstractions documentation to P2PRC --- Docs/Abstractions.md | 6 ++++++ Docs/README.md | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 Docs/Abstractions.md diff --git a/Docs/Abstractions.md b/Docs/Abstractions.md new file mode 100644 index 0000000..c1790a7 --- /dev/null +++ b/Docs/Abstractions.md @@ -0,0 +1,6 @@ +# Abstractions +The Abstractions package consists of blackboxed functions for P2PRC. + +## Functions +- ```Init()```: Initialises P2PRC with all the needed configurations. +- ```Start()```: Starts p2prc as a server and makes it possible to extend by adding other routes and functionality to P2PRC. \ No newline at end of file diff --git a/Docs/README.md b/Docs/README.md index e7b0f9b..0c9590c 100644 --- a/Docs/README.md +++ b/Docs/README.md @@ -2,6 +2,7 @@ # Table of contents 1. [Introduction](Introduction.md) 2. [Installation](Installation.md) +3. [Abstractions](Abstractions.md) 3. [Design Architecture](DesignArchtectureIntro.md) 1. [Client Module](ClientArchitecture.md) 2. [P2P Module](P2PArchitecture.md) @@ -13,6 +14,5 @@ 4. [Config Module](ConfigImplementation.md) 5. [Cli Module](CliImplementation.md) 6. [Plugin Module](PluginImplementation.md) - 7. [Generate Module](GenerateImplementation.md) 5. [Problems](https://github.com/Akilan1999/p2p-rendering-computation/issues)