inital commitHEADmaster

1 files changed, 25 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..788d870
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# TAR Tab bAR
+## Usage
+```lua
+require('tar').setup {}
+```
+## Configuration
+default:
+```lua
+{
+    seperator = "|",
+    noname = "[No Name]",
+    closeicon = "[x]"
+}
+```
+
+options:
+```lua
+{
+    seperator = function() end or "String", -- separator to go in-between titles
+    title = function() end, -- title to show
+    sign = function() end, -- text to show to the right of the title
+    noname = "String", -- title shown when no name is found
+    closeicon = "String" -- icon shown on the very right
+}
+```