From ebfebdaf2125b1d3da174affbac1953a8afb7a41 Mon Sep 17 00:00:00 2001 From: Thomas Brouard Date: Mon, 31 Oct 2016 16:10:14 +0100 Subject: [PATCH] Add minimal documentation --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8186bfe --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# electron-tabs + +> Simple tabs for Electron applications + +**WARNING: this module is in development and is not stable yet. Don't use it in your app.** + +## Exemple + +HTML: + +```html +
+
+
+
+``` + +Javascript: + +```javascript +const TabGroup = require("electron-tabs"); + +let tabGroup = new TabGroup({ + tabContainerSelector: ".tabs", + viewContainerSelector: ".views" +}); + +let tab = tabGroup.addTab({ + title: "Electron", + src: "http://electron.atom.io" +}); +``` + +## License + +The MIT License (MIT) - Copyright (c) 2016 Thomas Brouard \ No newline at end of file