Skip to content

Commit df6e80d

Browse files
committed
Update project READMEs
1 parent 7f73491 commit df6e80d

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1-
# Intecture API
1+
# Intecture APIs [![Build Status](https://travis-ci.org/intecture/api.svg?branch=master)](https://travis-ci.org/intecture/api) [![Coverage Status](https://coveralls.io/repos/github/Intecture/api/badge.svg?branch=master)](https://coveralls.io/github/Intecture/api?branch=master) [![Gitter](https://badges.gitter.im/Join\%20Chat.svg)](https://gitter.im/intecture/Lobby)
22

3-
This is a major restructuring of Intecture's core components. It goes like this:
3+
**Intecture is an API for managing your servers. Visit [intecture.io](https://intecture.io).**
4+
5+
---
6+
7+
Intecture's APIs (_cough_ and a binary) are the heart and soul of Intecture. Check out each component's `README.md` for details:
48

59
- [core](core/) - The core API that does all the heavy lifting
610
- [bindings](bindings/) - Rust FFI and language bindings
7-
- [proj](proj/) - Project helper functions
8-
- [agent](agent/) - Tiny daemon that wraps the core API
11+
- [proj](proj/) - Helpers and boilerplate to use in your Intecture projects
12+
- [agent](agent/) - Tiny daemon that exposes the core API as a service (for your hosts!)

agent/README.md

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

3-
Intecture Agent is a tiny daemon that exposes Intecture's API as a service. To consume this service, use the `host::remote::Plain` type from [core](../core/).
3+
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

55
## Usage
66

0 commit comments

Comments
 (0)