Initial documentation of application
Signed-off-by: Adrian Ambrożewicz <adrian.ambrozewicz@linux.intel.com>
Change-Id: I4f7fb2e05086eeef9ff5d401e0781e8a29e787f1
diff --git a/MAINTAINERS b/MAINTAINERS
new file mode 100644
index 0000000..16434b9
--- /dev/null
+++ b/MAINTAINERS
@@ -0,0 +1,53 @@
+Maintainers
+===============================
+
+`MAINTAINERS` files list the maintainers and reviewers for each individual
+repository. The `MAINTAINERS` file is found within the root directory of the
+repository. This `MAINTAINERS` file is for the telemetry repository.
+
+How to use this list:
+ Find the most specific section entry (described below) that matches where
+ your change lives and add the reviewers (R) and maintainers (M) as
+ reviewers. You can use the same method to track down who knows a particular
+ code base best.
+
+ Your change/query may span multiple entries; that is okay.
+
+ If you do not find an entry that describes your request at all, someone
+ forgot to update this list; please at least file an issue or send an email
+ to a maintainer, but preferably you should just update this document.
+
+Description of section entries:
+
+ Section entries are structured according to the following scheme:
+
+ X: NAME <EMAIL_USERNAME@DOMAIN> <IRC_USERNAME!>
+ X: ...
+ .
+ .
+ .
+
+ Where REPO_NAME is the name of the repository within the OpenBMC GitHub
+ organization; FILE_PATH is a file path within the repository, possibly with
+ wildcards; X is a tag of one of the following types:
+
+ M: Denotes maintainer; has fields NAME <EMAIL_USERNAME@DOMAIN> <IRC_USERNAME!>;
+ if omitted from an entry, assume one of the maintainers from the
+ MAINTAINERS entry.
+ R: Denotes reviewer; has fields NAME <EMAIL_USERNAME@DOMAIN> <IRC_USERNAME!>;
+ these people are to be added as reviewers for a change matching the repo
+ path.
+ F: Denotes forked from an external repository; has fields URL.
+
+ Line comments are to be denoted "# SOME COMMENT" (typical shell style
+ comment); it is important to follow the correct syntax and semantics as we
+ may want to use automated tools with this file in the future.
+
+ A change cannot be added to an OpenBMC repository without a MAINTAINER's
+ approval; thus, a MAINTAINER should always be listed as a reviewer.
+
+START OF MAINTAINERS LIST
+-------------------------
+
+M: Adrian Ambrozewicz <adrian.ambrozewicz@linux.intel.com> <aambroze!>
+R: Piotr Matuszczak <piotr.matuszczak@intel.com>
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..97642b9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# MonitoringService #
+This component implements middleware for sensors and metrics aggregation.
+
+
+## Capabilities ##
+This application is implementation of MonitoringService proposed in design`[1]`.
+
+It's responsible for:
+- on-demand creation of metric reports,
+ - aggregated sets of sensor values available in system `[2]`,
+- access to metric report in both pull and push model (triggers),
+- run-time monitoring of sensor`[3]` updates.
+
+## Use-cases ##
+- generic and centralized way to observe telemetry data inside system
+- back-end for Redfish TelemetryService`[4]`
+
+## References ##
+1. [OpenBMC platform telemetry design](https://github.com/openbmc/docs/blob/master/designs/telemetry.md)
+2. [Sensor support for OpenBMC](https://github.com/openbmc/docs/blob/master/architecture/sensor-architecture.md)
+3. [dbus-sensors](https://github.com/openbmc/dbus-sensors)
+4. [Redfish TelemetryService](https://redfish.dmtf.org/schemas/v1/TelemetryService.json)
\ No newline at end of file