update README.md

ClusterlessHQ · Aug 9, 2023 · 2e3daaf · 2e3daaf
1 parent 024a5fc
commit 2e3daaf
Show file tree

Hide file tree

Showing 4 changed files with 61 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -1,18 +1,46 @@
 # Clusterless
 
-## Status
+```text
+                                       ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐                                
+                                        Project A                                               
+                                       │      _                │                                
+                                             ╱ ╲      .─────.             ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ 
+┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐     ╔══╬═══▶▕   ▏═══▶(|||||||)═╬═════╗     Project C           │
+ Ingress Project                    ║        ╲ ╱      `─────'        ║    │    _                
+│                             │     ║  │      ▔                │     ║        ╱ ╲      .─────. │
+   ════▶╔ ═ ═ ╗                     ║      Workload                  ╚════╬═▶▕   ▏═══▶(|||||||) 
+│          _                  │     ║  └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘              ╲ ╱      `─────' │
+        ║ ╱#╲ ║      .─────.        ║                                     │    ▔                
+│  ════▶ ▕###▏ ════▶(|||||||)═╬═════╣                                          ▲               │
+        ║ ╲#╱ ║      `─────'        ║                                     └ ─ ─║─ ─ ─ ─ ─ ─ ─ ─ 
+│          ▔         Dataset  │     ║                                          ║                
+   ════▶╚ ═ ═ ╝                     ║  ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ╬ ─ ─ ─          
+│      Boundary               │     ║         _                     _          ║      │         
+ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─      ║  │     ╱ ╲      .─────.      ╱ ╲      .─────.             
+                                    ╚══════▶▕   ▏═══▶(|||||||)═══▶▕   ▏═══▶(|||||||)  │         
+                                       │     ╲ ╱      `─────'      ╲ ╱      `─────'             
+                                              ▔                     ▔                 │         
+                                       │Project B                                               
+                                        ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘
+```
 
-This project is under active development and many features are considered alpha.
+## Status
 
-Please do play around with this project in order to provide early feedback, but do expect things to change until we hit
-1.0 release.
+This project is under active development, some apis are experimental and may change between releases.
 
 Draft documentation can be found here: https://docs.clusterless.io/
 
+- [CLI usage](https://docs.clusterless.io/reference/1.0-wip/index.html#commands)
+- [Project components](https://docs.clusterless.io/reference/1.0-wip/index.html#components)
+- [Project file format](https://docs.clusterless.io/reference/1.0-wip/index.html#models)
+
 See the [ROADMAP](ROADMAP.md) for planned capabilities.
 
-For example scenarios, see the [clusterless-aws-example](https://github.com/ClusterlessHQ/clusterless-aws-examples)
-repo.
+For example scenarios, see
+
+- [clusterless-aws-example](https://github.com/ClusterlessHQ/clusterless-aws-examples) - simple examples to start with
+- [aws-s3-log-pipeline](https://github.com/ClusterlessHQ/aws-s3-log-pipeline) - end-to-end sample pipeline for
+  processing AWS S3 access logs
 
 ## About
 
@@ -57,8 +85,6 @@ Currently supported cloud substrates:
 
 - AWS
 
-See the [docs](docs) folder for wip documentation.
-
 ## Prerequisites
 
 _If you already have Node and npm, skip to the AWS CDK install._
@@ -100,6 +126,28 @@ The `bin` folder will have:
 
 > cls --help
 
+```text
+Usage: cls [-hVv] [-D=<String=String>]... [-P=<providerNames>]... [COMMAND]
+  -D, --property=<String=String>
+                  key=value properties, will be passed down
+  -h, --help      Show this help message and exit.
+  -P, --providers=<providerNames>
+                  provider substrates to target
+  -v, --verbose   Specify multiple -v options to increase verbosity.
+                  For example, `-v -v -v` or `-vvv`
+  -V, --version   Print version information and exit.
+Commands:
+  help       Display help information about the specified command.
+  config     manage local and global configuration settings
+  show       display details about providers, components, and project models
+  bootstrap  initialize a cloud provider placement
+  deploy     deploy a project into a declared placement
+  destroy    destroy a project deployed a declared placement
+  diff       compare local project changes with a deployed a declared placement
+  local      support for executing workloads locally
+  verify     verify project changes with a provider
+```
+
 Every region must be bootstrapped by the `cls` app before it can be used:
 
 > cls bootstrap help

diff --git a/ROADMAP.md b/ROADMAP.md
@@ -6,6 +6,7 @@ Things not yet implemented.
 
 Most things in the cli have yet to be implemented.
 
+- https://docs.clusterless.io/reference/1.0-wip/index.html#commands
 - [CommandLineUsage](docs/CommandLineUsage.adoc)
 
 # Capabilities
@@ -26,7 +27,9 @@ Most things in the cli have yet to be implemented.
    3. AWS Sagemaker training/validation
 6. Common data processing workloads
    1. Data reformatting (from text/json to binary/parquet)
+      2. https://github.com/ClusterlessHQ/tessellate
    2. Dynamic data repartitioning (partitions based on data like timestamps)
+      3. https://github.com/ClusterlessHQ/tessellate
    3. Predicate/duplicate index creation and data filtering
 7. Join Barrier implementations
 8. Scheduled arc executions

diff --git a/docs/CommandLineUsage.adoc b/docs/CommandLineUsage.adoc
@@ -1,5 +1,7 @@
 = Command Line Usage
 
+Proposed commands for the cli.
+
 The command line:
 
 ====

diff --git a/docs/GettingStarted.adoc b/docs/GettingStarted.adoc