Skip to content
This repository has been archived by the owner on Mar 9, 2022. It is now read-only.

Improve readme #40

Merged
merged 3 commits into from Feb 28, 2018
Merged

Improve readme #40

merged 3 commits into from Feb 28, 2018

Conversation

oplehto
Copy link
Contributor

@oplehto oplehto commented Feb 27, 2018

Some improvements to the first part of the README to highlight the killer features of spout.

Copy link
Contributor

@mjs mjs left a comment

Choose a reason for hiding this comment

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

Great. This is a much better intro.

README.md Outdated
supported. [NATS] is used for messaging between the various influx-spout
components.
influx-spout is an open source messaging system that routes and processes
[InfluxDB] [line protocol] metrics from agents (For example [Telegraf]) to
Copy link
Contributor

Choose a reason for hiding this comment

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

s/For/for/

README.md Outdated
processing and storage backends (InfluxDB, Kapacitor etc.).

Key features:
- Proven ability to handle high volumes of data (>500k points per second) in a production environment
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps wrap this line and some of the other longs ones below so the file looks nice when being read in plain text too

README.md Outdated
components.
influx-spout is an open source messaging system that routes and processes
[InfluxDB] [line protocol] metrics from agents (For example [Telegraf]) to
processing and storage backends (InfluxDB, Kapacitor etc.).
Copy link
Contributor

Choose a reason for hiding this comment

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

add a link for Kapacitor?

@oplehto oplehto merged commit 02605c0 into master Feb 28, 2018
@oplehto oplehto deleted the improve_readme branch February 28, 2018 05:52
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.

None yet

2 participants