From fd660f3b56c507372683b857f33856a070714c30 Mon Sep 17 00:00:00 2001
From: SEK1RO <vlad@sek1.ro>
Date: Sat, 21 Sep 2024 22:30:36 +0300
Subject: [PATCH] feat(README.md): contents, installation, contribution

---
 README.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 62 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index aeed142..8dafbf5 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,63 @@
-# libbase
+<img style="height: 40px; width: 100%; object-fit: contain;" src="https://i.imgur.com/ZOisFIu.png" />
 
-encoding/decoding from arbitrary base
\ No newline at end of file
+<p style="text-align: center;"> c++ encoding/decoding from arbitrary base </p>
+
+<div style="display: flex; flex-direction: row; justify-content: center; gap: 8px;">
+    <a href="https://repology.org/project/libbasen/versions">
+        <img src="https://repology.org/badge/tiny-repos/libbasen.svg" alt="Packaging status">
+    </a>
+    <a href="https://repology.org/project/libbasen/versions">
+        <img src="https://repology.org/badge/latest-versions/libbasen.svg" alt="latest packaged version(s)">
+    </a>
+</div>
+
+---
+
+## Contents
+[Installation](#installation)
+[Contributing](#contributing)
+
+---
+
+## Installation
+
+Automatically from specified repositories:
+
+[![Packaging status](https://repology.org/badge/vertical-allrepos/libbasen.svg)](https://repology.org/project/libbasen/versions)
+
+Manually using make:
+```
+make -j $(nproc)
+sudo make i USRDIR=(Your installation dir)
+```
+Uninstall:
+```
+sudo make uni USRDIR=(Your installation dir)
+```
+For build with with debug flags:
+```
+make -j $(nproc) DEBUG=
+```
+For build tests:
+```
+make tests -j $(nproc) DEBUG=
+```
+And also flag for dynamic linking (if possible):
+```
+make tools -j $(nproc) SHARED=
+```
+
+---
+
+## Contributing
+
+Main branch is under protection rules, so you should create pull request. After merging will be runned [authors.sh](https://github.com/vSEK1RO/libbasen/blob/main/authors.sh) for adding all contributors usernames and their number of commits to [AUTHORS](https://github.com/vSEK1RO/libbasen/blob/main/AUTHORS) file.
+
+Now we would like to implement the following features:
+- Base32
+- BCH
+- Bech32
+
+---
+
+[:arrow_up:Contents](#contents)
\ No newline at end of file