diff --git a/README.md b/README.md index 96820b5..09ea0ca 100644 --- a/README.md +++ b/README.md @@ -5,21 +5,21 @@ wget run https://raw.githubusercontent.com/guillaumearm/cc-libs/master/install.lua ``` -## Apis -- `/apis/eventloop`: a simple event loop api -- `/apis/net`: api to simplify sending and receiving routed messages (based on `eventloop` library) +## APIs +- `/apis/eventloop`: a simple event loop API. +- `/apis/net`: an API to simplify sending and receiving routed messages, based on the `eventloop` library. ## Servers -All servers are automatically started at boot +All servers are automatically started at boot. -- `/servers/ping-server`: allow a machine to respond to a `ping` command. -- `/servers/cube-server`: allow a machine to be controllable via `cube`. +- `/servers/ping-server`: allows a machine to respond to a `ping` command. +- `/servers/cube-server`: allows a machine to be controllable via `cube`. - `/servers/cube-boot.lua`: `cube` boot script. ## Programs -- `router`: route messages (you need to setup a router to be able to use all `apis/net` based programs and libs) -- `ping` : ping machines (use `apis/net`) -- `cube`: cube client for deployment (use `cube help` command for more details) +- `router`: routes messages. You need to set up a router to use all `apis/net`-based programs and libraries. +- `ping`: pings machines using `apis/net`. +- `cube`: cube client for deployment. Use the `cube help` command for more details. - `goo`: turtle program for Just Dire Things goo block processing. ## Development