From b868b9ccb093fda868042dd148df1bbfba687439 Mon Sep 17 00:00:00 2001
From: Szymon Wiszczuk <37072867+golota60@users.noreply.github.com>
Date: Sun, 14 Jan 2024 17:32:30 +0100
Subject: [PATCH] chore: update readmes (#13)

* chore: update every packages readme

* update publishing process docs
---
 LICENSE                          | 21 +++++++++++++++++++++
 PUBLISHING.md                    |  2 +-
 oxytail-base/README.md           |  6 ++++++
 oxytail-theme-dark/README.md     |  6 ++++++
 oxytail-theme-defaults/README.md |  6 ++++++
 5 files changed, 40 insertions(+), 1 deletion(-)
 create mode 100644 LICENSE
 create mode 100644 oxytail-base/README.md
 create mode 100644 oxytail-theme-dark/README.md
 create mode 100644 oxytail-theme-defaults/README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d6a6337
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Szymon Wiszczuk and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
\ No newline at end of file
diff --git a/PUBLISHING.md b/PUBLISHING.md
index 64b9ce6..2f8b03e 100644
--- a/PUBLISHING.md
+++ b/PUBLISHING.md
@@ -1,7 +1,7 @@
 Currently, publishing is done manually. Simply,
 
 1. Create a new branch
-2. Bump the version and commit
+2. Bump the version of each package and commit. We want to keep sync between each oxytail package version. Also update documentation and every mention of version to be installed(including each packages `Cargo.toml`!).
 3. Run the following commands
 
 ```
diff --git a/oxytail-base/README.md b/oxytail-base/README.md
new file mode 100644
index 0000000..48087f4
--- /dev/null
+++ b/oxytail-base/README.md
@@ -0,0 +1,6 @@
+[![crates.io](https://img.shields.io/crates/v/oxytail-base.svg)](https://crates.io/crates/oxytail-base)
+[![Released API docs](https://docs.rs/oxytail-base/badge.svg)](https://docs.rs/oxytail-base)
+
+## Oxytail Base
+
+This package contains the base widgets for [oxytail](https://github.com/golota60/oxytail) and the "core" of how themes work. Refer to that repos README for more info!
diff --git a/oxytail-theme-dark/README.md b/oxytail-theme-dark/README.md
new file mode 100644
index 0000000..bd9c4bb
--- /dev/null
+++ b/oxytail-theme-dark/README.md
@@ -0,0 +1,6 @@
+[![crates.io](https://img.shields.io/crates/v/oxytail-dark-theme.svg)](https://crates.io/crates/oxytail-dark-theme)
+[![Released API docs](https://docs.rs/oxytail-dark-theme/badge.svg)](https://docs.rs/oxytail-dark-theme)
+
+## Oxytail dark theme
+
+This package contains the implementation for a dark theme for [oxytail](https://github.com/golota60/oxytail). Refer to that repos README for more info!
\ No newline at end of file
diff --git a/oxytail-theme-defaults/README.md b/oxytail-theme-defaults/README.md
new file mode 100644
index 0000000..3712f25
--- /dev/null
+++ b/oxytail-theme-defaults/README.md
@@ -0,0 +1,6 @@
+[![crates.io](https://img.shields.io/crates/v/oxytail-theme-defaults.svg)](https://crates.io/crates/oxytail-theme-defaults)
+[![Released API docs](https://docs.rs/oxytail-theme-defaults/badge.svg)](https://docs.rs/oxytail-theme-defaults)
+
+## Oxytail theme defaults
+
+This package contains a set of defaults for creating custom [oxytail](https://github.com/golota60/oxytail) themes. Refer to that repos README for more info!