Skip to content
This repository has been archived by the owner on Sep 21, 2023. It is now read-only.

docs: add README #12

Merged
merged 3 commits into from
Dec 1, 2015
Merged

docs: add README #12

merged 3 commits into from
Dec 1, 2015

Conversation

colhom
Copy link
Contributor

@colhom colhom commented Nov 28, 2015

addresses #9

@@ -0,0 +1,74 @@
khealth
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Atx headers: # khealth

@colhom
Copy link
Contributor Author

colhom commented Nov 30, 2015

@joshix suggestions digested


A khealth *Module* is a single command that invokes a set of Routines and a single Collector. The Collector gathers events from the Routines and exposes metrics on its status endpoint.

* **cmd/**:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

**`cmd/`**

(mono font for file path)

@joshix
Copy link
Contributor

joshix commented Dec 1, 2015

@colhom sorry for that misfire and the comment churn. Comments now inline to tip of this PR. LGTM after those fixes.

consistent text formatting for recurring entities
clearer english, proper grammar
explain NewRoutine method in full
colhom added a commit that referenced this pull request Dec 1, 2015
@colhom colhom merged commit 4be41d0 into master Dec 1, 2015
@colhom colhom deleted the add-readme branch December 1, 2015 01:11
@colhom colhom mentioned this pull request Dec 1, 2015
joshix pushed a commit to joshix/khealth that referenced this pull request Dec 1, 2015
joshix pushed a commit to joshix/khealth that referenced this pull request Dec 1, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants