From d14005c12944e1f8272926954766be77f9036678 Mon Sep 17 00:00:00 2001
From: tom-mi <tom-mi@users.noreply.github.com>
Date: Sun, 15 Nov 2015 19:56:56 +0100
Subject: [PATCH] Update README
---
README.md | 38 ++++++++++++++++++++++++++++++++++++++
1 file changed, 38 insertions(+)
diff --git a/README.md b/README.md
index 5ddf934..a6d8cd0 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,39 @@
# python-mkp
+
+[](https://travis-ci.org/tom-mi/python-mkp)
+
+Pack or unpack [Check_MK](https://mathias-kettner.de/check_mk.html) mkp files.
+
+## Installation
+
+ pip install mkp
+
+## Usage
+
+### Extract mkp package
+
+ import mkp
+
+ package = mkp.load_file('foo-1.0.mkp')
+ print(package.info)
+ package.extract_files('path/to/somewhere')
+
+### Pack files to mkp package
+
+ import mkp
+
+ info = {
+ 'author': 'tom-mi',
+ 'description': 'Test the system',
+ 'download_url': 'http://example.com/',
+ 'files': mkp.find_files('path/to/files'),
+ 'name': 'test',
+ 'title': 'Test',
+ 'version': '1.0',
+ 'version.min_required': '1.2.3',
+ }
+ mkp.pack_to_file(info, 'path/to/files', 'test-1.0.mkp')
+
+## License
+
+This software is licensed under GPLv2.
--
GitLab