diff --git a/README.md b/README.md index 2027e1e69..18cb42a37 100644 --- a/README.md +++ b/README.md @@ -199,10 +199,7 @@ Documentation for snap will be kept in this repository for now. We would also li * [tribe](docs/TRIBE.md) ### Examples -There are interesting examples of using snap in every plugin repository. For the full list of plugins, review the [plugin catalog](https://github.com/intelsdi-x/snap/blob/master/docs/PLUGIN_CATALOG.md): - -* [configs](examples/configs/) is a basic example of the configuration file that powers your plugins -* [tasks](examples/tasks/) has JSON-encoded execution requests for snap plugins +There are interesting examples of using snap in every plugin repository. For the full list of plugins, review the [plugin catalog](docs/PLUGIN_CATALOG.md). There is an [Examples](examples/README.md) package that demonstrates snap configurations and usages. ### Roadmap We have a few known features we want to take on from here while we remain open for feedback after public release. They are: diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 000000000..4b7bfb46f --- /dev/null +++ b/examples/README.md @@ -0,0 +1,27 @@ + + +# Examples +Example package contains a collection of snap examples and [videos](./videos.md) that demonstrate the snap libraries and usages. + +* [configs](./configs) is an example of the global configuration file that powers your plugins +* [influxdb-grafana](./influxdb-grafana) has an example of [snap Influxdb publisher plugin](https://github.com/intelsdi-x/snap-plugin-publisher-influxdb). The example demonstrates +Intel [PCM](https://software.intel.com/en-us/articles/intel-performance-counter-monitor) (Performance Counter Monitor) and [PSUTIL](https://github.com/intelsdi-x/snap-plugin-collector-psutil) (Processes and System Utilization) plugins to publish data into Influxdb and using Grafana to view the results. +* [riemann](./riemann) has an example of [snap Riemann publisher plugin](https://github.com/intelsdi-x/snap-plugin-publisher-riemann) +* [tasks](./tasks) has JSON and YAML formatted execution requests for snap tasks \ No newline at end of file