aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2850c07
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Elixir Prometheus.IO #
+
+Elixir API library for querying data from [Prometheus][1].
+
+## Installation ##
+
+The package can be installed by adding `ex_prometheus_io` to your list of
+dependencies in `mix.exs`.
+
+ def deps do
+ [{:ex_prometheus_io, "~> 0.0.1"}]
+ end
+
+## License ##
+
+This code is provided AS-IS, WITHOUT any warranty, expressed or implied, under
+the terms and conditions of the Apache, version 2.0, license. For more
+information, see the provided LICENSE file. If your distribution did not come
+with a LICENSE file, you may read about the terms [online][2].
+
+[1]: http://prometheus.io
+
+[2]: http://www.apache.org/licenses/LICENSE-2.0