Skip to content

Commit eac79bc

Browse files
committed
feat(README): add some more intro text
1 parent 0b60093 commit eac79bc

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,25 @@
11
# go-systemd
22

3-
Go bindings to systemd socket activation, journal and D-BUS APIs.
3+
Go bindings to systemd. The project has three packages:
44

5-
## Go Docs
5+
- activation - for writing and using socket activation from Go
6+
- journal - for writing to systemd's logging service, journal
7+
- dbus - for starting/stopping/inspecting running services and units
8+
9+
Go docs for the entire project are here:
610

711
http://godoc.org/github.com/coreos/go-systemd
812

913
## Socket Activation
1014

11-
See an example in `examples/activation/httpserver.go`. For easy debugging use
12-
`/usr/lib/systemd/systemd-activate`
15+
An example HTTP server using socket activation can be quickly setup by
16+
following this README on a Linux machine running systemd:
17+
18+
https://github.com/coreos/go-systemd/tree/master/examples/activation/httpserver
19+
20+
## Journal
21+
22+
Using this package you can submit journal entries directly to systemd's journal taking advantage of features like indexed key/value pairs for each log entry.
1323

1424
## D-Bus
1525

0 commit comments

Comments
 (0)