Update documentation

undyingwraith · Jan 26, 2025 · d04554c · d04554c
1 parent 5d4d2f6
commit d04554c
Show file tree

Hide file tree

Showing 7 changed files with 122 additions and 47 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Undying Wraith
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -2,9 +2,19 @@
 
 Interplanetary Media Center
 
-## Abstract
+![GitHub Repo stars](https://img.shields.io/github/stars/undyingwraith/ipmc)
+![GitHub License](https://img.shields.io/github/license/undyingwraith/ipmc)
 
-A piece of software made to access media libraries hosted on [IPFS](https://ipfs.io)
+
+A piece of software made to access media libraries hosted on [IPFS](https://ipfs.io).
+
+## Screenshots
+
+![screenshot](./docs/images/screenshot1.png)
+
+## Documentation
+
+The documentation can be found [here](./docs/README.md)
 
 ## Getting started
 
@@ -13,58 +23,55 @@ A piece of software made to access media libraries hosted on [IPFS](https://ipfs
 - nodejs >= v20.12.2
 - yarn (installed through [corepack](https://yarnpkg.com/corepack))
 
+### Clone the repository
+
+```shell
+git clone https://github.com/mfts/papermark.git
+cd papermark
+```
+
 ### Installing dependencies
 
-```bash
+```shell
 yarn install
 ```
 
 ### Running it in dev mode
 
 Run the following commands in paralell:
 
-```bash
+```shell
 yarn workspace watch
 yarn workspace ipmc-desktop run dev
 ```
 
 *NOTE: for first time install you might need to run a build first*
-```bash
+```shell
 yarn build
 ```
 
 ## Packages
 
-### ipmc-interfaces
-
-Defines interfaces for MetaData and services.
-
-### ipmc-core
-
-Contains Services and utilities.
-
-### ipmc-ui
-
-Contains a react app that acts as ui.
-
-### ipmc-desktop
-
-Contains a electron app using the *ipmc-ui*.
-
-## Concepts
-
-### Profiles
-
-- Keep different configurations for ipfs networks.
-
-### Libraries
-
-- Keep different media sources
-- bound to profiles
-
-Types:
-
-- Movie/Video
-- Music/Audio
-- Images
-- Comics
+| Path | Name | Description |
+| - | - | - |
+| ./packages/interfaces | **ipmc-interfaces** | Defines interfaces for MetaData and services. |
+| ./packages/core | **ipmc-core** | Contains Services and utilities. |
+| ./packages/ui | **ipmc-ui** | Contains a react app that acts as ui. |
+| ./packages/desktop | **ipmc-desktop** | Contains a electron app using the *ipmc-ui*. |
+| ./packages/webui | **ipmc-webui** | Contains a react app using the *ipmc-ui*. |
+
+## Contributing
+1. Fork the repository.
+2. Create a new branch: `git checkout -b feature/feature-name`.
+3. Make your changes.
+4. Push your branch: `git push origin feature/feature-name`.
+5. Create a pull request.
+
+## License
+This project is licensed under the [MIT License](LICENSE).
+
+## Contributors
+
+<a href="https://github.com/undyingwraith/ipmc/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=undyingwraith/ipmc" />
+</a>
diff --git a/docs/Profile.md b/docs/Profile.md
@@ -0,0 +1,25 @@
+# Profile
+
+There are two types of profiles (internal, remote). The main difference being that the remote one connects to an already existing IPFS node, where as the internal one will spawn its own node.
+
+## Common options
+
+| Name | Description | Optional |
+| - | - | - |
+| id | A unique id. | ❌ |
+| libraries | A list of libraries. For more info see [here](./library/README.md). | ❌ |
+| name | Name of the profile that gets displayed in the app. | ❌ |
+
+## Remote
+
+| Name | Description | Optional |
+| - | - | - |
+| url | Url of the ipfs daemon api. | ❌ |
+
+## Internal
+
+| Name | Description | Optional |
+| - | - | - |
+| swarmKey | Swarm key used to connect to private networks. | ✅ |
+| bootstrap | List of bootstrap addresses. A default list will be used if none are provided. | ✅ |
+| port | Port of the node. Will use any available port if not set. | ✅ |
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,13 @@
+# IPMC Documentation
+
+## Profiles
+
+A profile has all the information on how to connect to an IPFS network. And where to lookup the latest CID's of libraries.
+
+For detailed info see [here](./Profile.md).
+
+## Libraries
+
+Libraries are a collection of media items of a specific type and are tied to a specific profile.
+
+For detailed info see [here](./library/README.md).
diff --git a/docs/images/screenshot1.png b/docs/images/screenshot1.png
diff --git a/docs/library/README.md b/docs/library/README.md
@@ -0,0 +1,18 @@
+# Libraries
+
+## Types
+
+- [TV Shows](./Series.md)
+- [Movies](./Movies.md)
+- [Music](./Music.md)\*
+
+\* _Not Implemented_
+
+## Options
+
+| Name | Description |
+| - | - |
+| id | A unique id. |
+| type | The type of library. For more info see the types above. |
+| name | Name of the library thats displayed in the app. |
+| upstream | Upstream url of where to fetch the newest listing. |
diff --git a/docs/library/index.md b/docs/library/index.md