From 4ac794751e755888cd7f4c1f8291561fe7ef722f Mon Sep 17 00:00:00 2001
From: RektPunk <110188257+RektPunk@users.noreply.github.com>
Date: Wed, 18 Sep 2024 18:23:24 +0900
Subject: [PATCH] [Chore] fix readme and examples (#9)

---
 README.md                          | 25 ++++++++++++++++++++++++-
 {experiments => examples}/basic.py |  0
 2 files changed, 24 insertions(+), 1 deletion(-)
 rename {experiments => examples}/basic.py (100%)

diff --git a/README.md b/README.md
index abe65fb..1e8ea9a 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,24 @@
-# imbalanced-lightgbm
+# Imbalanced-LightGBM
+
+  <a href="https://github.com/RektPunk/Imbalance-LightGBM/blob/main/LICENSE">
+    <img alt="License" src="https://img.shields.io/github/license/RektPunk/Imbalance-LightGBM.svg">
+  </a>
+  <a href="https://github.com/RektPunk/Imbalance-LightGBM/actions/workflows/lint.yaml">
+    <img alt="Lint" src="https://github.com/RektPunk/Imbalance-LightGBM/actions/workflows/lint.yaml/badge.svg?branch=main">
+  </a>
+
+This repository contains implementations of weighted loss and focal loss functions specifically designed for classification problems using LightGBM.
+
+## Installation
+Not implemented yet.
+
+
+## Example
+Please refer to the [**Examples**](https://github.com/RektPunk/Imbalance-LightGBM/tree/main/examples) provided for further clarification.
+
+
+## Acknowledgements
+This repository would not exist without the excellent work from:
+
+- [LightGBM](https://github.com/microsoft/LightGBM)
+- [Imbalance-XGBoost](https://github.com/jhwjhw0123/Imbalance-XGBoost)
diff --git a/experiments/basic.py b/examples/basic.py
similarity index 100%
rename from experiments/basic.py
rename to examples/basic.py