refactor: git repo best practices

8 files changed, 39 insertions, 0 deletions

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..1d47b15
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,12 @@
+Copyright kj_sh604 <https://github.com/kj-sh604>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1635287
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# README.txt
+
+```plaintext
+
+panahone ⛅
+-------------
+
+simple gtk3 systray weather applet using wttr.in's API written in Python.
+
+(i really just wanted to practice using the `requests` and `json` modules in python so i made this).
+
+usage
+-------------
+
+usage: panahone [-h] [-l LOCATION] [-f]
+
+options:
+  -h, --help            show this help message and exit
+  -l, --location LOCATION
+                        location for weather
+  -f, --fahrenheit      use Fahrenheit instead of Celsius
+
+```
+
+# 📸
+
+![GIF animation of panahone ⛅](assets/demo.gif)
diff --git a/assets/demo.gif b/assets/demo.gif
new file mode 100644
index 0000000..82fe807
--- /dev/null
+++ b/assets/demo.gif
diff --git a/panahone.png b/assets/panahone.png
index 5ab2b0d..5ab2b0d 100644
--- a/panahone.png
+++ b/assets/panahone.png
diff --git a/.gitignore b/src/.gitignore
index 9c64fb6..9c64fb6 100644
--- a/.gitignore
+++ b/src/.gitignore
diff --git a/panahone b/src/panahone
index 0332a92..0332a92 100755
--- a/panahone
+++ b/src/panahone
diff --git a/src/panahone.png b/src/panahone.png
new file mode 100644
index 0000000..5ab2b0d
--- /dev/null
+++ b/src/panahone.png
diff --git a/requirements.txt b/src/requirements.txt
index 7c78635..7c78635 100644
--- a/requirements.txt
+++ b/src/requirements.txt