Skip to content

Commit e2a3a98

Browse files
committed
Update project READMEs
1 parent dcc53cd commit e2a3a98

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

agent/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Intecture Agent
1+
# Agent
22

33
Intecture Agent is a tiny daemon that exposes Intecture's core API as a service. This service should be running on each of your hosts to allow Intecture to manage them remotely. To connect to a remote host, use the `host::remote::Plain` type from [core](../core/).
44

core/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Core API
2+
3+
The core API contains the endpoints used to configure a host, as well as the underlying OS abstractions that they are built on. Usually you'll use Intecture Proj ([proj/](../proj/)) instead, which reexports the core API, though for some applications, the core API will suffice.
4+
5+
## Project structure
6+
7+
The core API is organised into a series of directories for each endpoint (e.g. `command/`, `host/` etc.). Within each endpoint is a `providers/` directory that houses the underlying abstractions.
8+
9+
## Usage
10+
11+
For API usage, check out the [examples](examples/).

0 commit comments

Comments
 (0)