docs(readme): tagline-first intro with verified entry-point links
This commit is contained in:
1 file changed
+21
-4
@@ -1,7 +1,12 @@
|
||||
# archipelago
|
||||
|
||||
The archie-core marketplace. One directory per extension surface; each surface
|
||||
directory holds one subdirectory per extension.
|
||||
**The archie-core marketplace.**
|
||||
|
||||
One directory per extension surface; each surface directory holds one
|
||||
subdirectory per extension. An extension ships as a package: a `package.yaml`
|
||||
plus its Go source or data files.
|
||||
|
||||
## Layout
|
||||
|
||||
```
|
||||
secret-engines/<name>/ package.yaml + Go source, served over secretengine.v1
|
||||
@@ -18,8 +23,9 @@ scripts/publish.sh pack every package and publish the signed catalogue
|
||||
|
||||
A surface's contract is the gRPC service in archie-core's `proto/<surface>/v1`.
|
||||
Regenerate `sdk/` from it with `buf generate ../archie-core/proto --path
|
||||
../archie-core/proto/<surface>`. An extension can be written in any language;
|
||||
the Go SDK is a convenience.
|
||||
../archie-core/proto/<surface>` (see [buf.gen.yaml](buf.gen.yaml)). An
|
||||
extension can be written in any language; the Go SDK in [sdk/](sdk) is a
|
||||
convenience.
|
||||
|
||||
## Safety
|
||||
|
||||
@@ -61,3 +67,14 @@ A data package (no `main.go`) needs only the install: its files are projected
|
||||
into the matching resource and withdrawn when the package is removed.
|
||||
|
||||
Platform: linux/amd64.
|
||||
|
||||
## Docs and entry points
|
||||
|
||||
- Example package for each surface: [workflow](workflows/firewall/package.yaml),
|
||||
[channel](channels/email/package.yaml), [forge](forge/gitea/package.yaml),
|
||||
[secret engine](secret-engines/bws/package.yaml),
|
||||
[playbook](playbooks/bug-tdd/package.yaml),
|
||||
[profile](profiles/network-investigator/package.yaml),
|
||||
[skill](skills/archie-wf-go-gate/SKILL.md)
|
||||
- Pack one package or publish the signed catalogue:
|
||||
[scripts/pack.sh](scripts/pack.sh), [scripts/publish.sh](scripts/publish.sh)
|
||||
Reference in new issue
Block a user