diff --git a/docs/root/07-registry.md b/docs/root/07-registry.md index d1fd3c5..de318cc 100644 --- a/docs/root/07-registry.md +++ b/docs/root/07-registry.md @@ -14,7 +14,7 @@ Just like modern development environments, Mush is equipped with a registry wher The `.packages` file is the cornerstone of the Mush distributed registry. It enables a decentralized system where anyone can contribute and maintain packages. Here's a breakdown of how it works and the benefits it offers. -## How It Works +## The Root Node The `.packages` file lists all the packages that will be installed or updated during usage. The main file is hosted at [Mush Repository](https://github.com/javanile/mush/blob/main/.packages), and everyone can request a pull to this file to add their packages or registries. @@ -38,6 +38,8 @@ package test_with_bashunit https://github.com/javanile/mush.git packages/test_wi ## Creating Your Registry +To create your registry and add your packages to the main index, follow these steps: + 1. **Create Your Repository**: Anyone can create their repository anywhere they like. 2. **Add a `.packages` File**: In the root of your repository, create a `.packages` file that describes the packages it contains. For example: @@ -79,6 +81,8 @@ package toolB^2.0.0 https://github.com/devops/toolB.git packages/toolB_v2 ## Benefits of a Distributed Registry +We believe that a distributed registry offers several advantages over a centralized one: + 1. **Decentralization**: A distributed registry removes the need for a single point of failure. Multiple users can maintain their own package lists. 2. **Scalability**: The registry can grow organically as new users add their packages, without requiring centralized management. 3. **Redundancy**: Multiple registries ensure that even if one registry is down, others can provide the required packages.