+
+## Installation
+
+### npm
+```sh
+npm install @taubyte/spore-drive
+```
+
+### yarn
+```sh
+yarn add @taubyte/spore-drive
+```
+
+## Example Usage
+
+### Load Configuration
+
+Create a new configuration in memory:
+```ts
+import { Config } from "@taubyte/spore-drive";
+
+const config = new Config();
+await config.init();
+```
+
+Or load a configuration from a source, for example, the local file system:
+```ts
+const config = new Config(`/absolute/path/to/config`);
+await config.init();
+```
+
+### Define Cloud Infrastructure
+
+You can define your cloud infrastructure as follows:
+```ts
+const cloudDomain = await config.Cloud().Domain();
+await cloudDomain.Root().Set("test.com");
+await cloudDomain.Generated().Set("gtest.com");
+await cloudDomain.Validation().Generate();
+```
+
+For a complete example, see the `example` folder in the `pkg/spore-drive` directory.
+
+### Instantiate a Drive
+
+```ts
+import { Drive, TauLatest } from "@taubyte/spore-drive";
+
+const drive = new Drive(config, TauLatest);
+await drive.init();
+```
+
+### Plot a Course
+
+```ts
+const course = await drive.plot(new CourseConfig(["shape1"]));
+```
+
+`shape1` is used to select hosts to be deployed to.
+
+### Deploy
+
+```ts
+await course.displace();
+
+console.log("Displacing...");
+for await (const progress of await course.progress()) {
+ console.log(progress);
+}
+console.log("Done");
+```
+
+### Progress Bars
+
+You can visualize the deployment progress using progress bars:
+
+```ts
+import { ProgressBar } from "@opentf/cli-pbar";
+
+function extractHost(path: string): string {
+ const match = path.match(/\/([^\/]+):\d+/);
+ return match ? match[1] : "unknown-host";
+}
+
+function extractTask(path: string): string {
+ const parts = path.split("/");
+ return parts[parts.length - 1] || "unknown-task";
+}
+
+async function displayProgress(course: Course) {
+ const multiPBar = new ProgressBar({ size: "SMALL" });
+ multiPBar.start();
+ const taskBars: RecordbtT(*yVn}ghhhUxFBtxE%~t-bv>wF1Jrc$j>CSiqI9|v
zRfVfkh_Y+2%GkCB>8?0KkUFEcMKsJo39faETbp-Vry^LlJxHJOs^>ca={x#`J2pgb
z!}b%G-k-Q`?Cr4cZ8jaGzZ7oDYxOcI$WR7mVZ4i}57A=0dlaziv>$Ba1GA~$)gs>W
zI1kmGzGvnWY_ku;vh8tSeOfpUw^C;{>)*O&G{u{EpVK!4YZ;zL^1e|Ya@q)X(Fp3r
zXkoy%BTZJMxjVMExJi|t5Ug8qPZ#&VK6uX%1w&VCt>gA3`zNXVb^(zN+T%Z7veUIk{(kebV
zBKMbx2ls!^