Merge pull request #10 from pacstall/docs/readme

docs: add initial readme

README.md

@@ -0,0 +1,72 @@
+<h1 align="center">LibPacstall</h1>
+<p align="center"><b>Backend API library for Pacstall</b></p>
+
+<p align="center">
+    <!-- Programming info -->
+    <a href="https://www.python.org/"><img alt="python 3.8+" src="https://img.shields.io/badge/python-3.8%2B-306998?logo=python&logoColor=white&style=for-the-badge" /></a>
+    <a href="https://github.com/psf/black"><img alt="code style: 3.8+" src="https://img.shields.io/badge/code%20style-black-black?style=for-the-badge" /></a>
+    <a href="https://www.codacy.com/gh/pacstall/libpacstall/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=pacstall/libpacstall&amp;utm_campaign=Badge_Grade">
+        <img alt="Codacy branch grade" src="https://img.shields.io/codacy/grade/e2155a8b2f0e4804b9c6a4b1441c3b3a?label=code%20quality&logo=codacy&logoColor=white&style=for-the-badge" />
+    </a>
+    <a href="https://www.gnu.org/software/bash"><img alt="bash v5" src="https://img.shields.io/badge/bash-v5-chateauGreen?logo=gnubash&logoColor=white&style=for-the-badge" /></a>
+    <br />
+    <!-- Social -->
+    <a href="https://discord.gg/yzrjXJV6K8"><img alt="join discord" src="https://img.shields.io/discord/839818021207801878?color=5865F2&label=Discord&logo=discord&logoColor=FFFFFF&style=for-the-badge" /></a>
+    <a href="https://reddit.com/r/pacstall"><img src="https://img.shields.io/reddit/subreddit-subscribers/pacstall?label=Reddit&color=FF4301&style=for-the-badge&logo=reddit&logoColor=FFFFFF" loading="lazy" /></a>
+    <a href="https://social.linux.pizza/web/@pacstall">
+        <img alt="Mastodon Follow" src="https://img.shields.io/mastodon/follow/107278715447740005?color=3088d4&domain=https%3A%2F%2Fsocial.linux.pizza&label=Mastodon&logo=mastodon&logoColor=white&style=for-the-badge" loading="lazy" />
+    </a>
+    <a href="https://matrix.to/#/#pacstall:matrix.org"><img alt="join matrix" src="https://img.shields.io/matrix/pacstall:matrix.org?color=888888&label=Matrix&logo=Matrix&style=for-the-badge" /></a>
+    <br />
+</p>
+
+## What is this
+
+LibPacstall is a backend API library for
+[Pacstall](https://github.com/pacstall/pacstall).
+
+## Installation
+
+To install the latest release run:
+
+```console
+$ pip install libpacstall
+```
+
+To install the latest development build run:
+
+```console
+$ pip install git+https://github.com/pacstall/libpacstall@develop
+```
+
+## Stats
+
+<p align="center"><img alt="Repobeats analytics image" src="https://repobeats.axiom.co/api/embed/2238a489ea987735d3dff77778b2f15b93d17fd3.svg" /></p>
+
+## License
+
+<p align="center"><img alt="GPL-3.0-or-later" height="100" src="https://www.gnu.org/graphics/gplv3-or-later.svg" /></p>
+
+```monospace
+    __    _ __    ____                  __        ____
+   / /   (_) /_  / __ \____ ___________/ /_____ _/ / /
+  / /   / / __ \/ /_/ / __ `/ ___/ ___/ __/ __ `/ / /
+ / /___/ / /_/ / ____/ /_/ / /__(__  ) /_/ /_/ / / /
+/_____/_/_.___/_/    \__,_/\___/____/\__/\__,_/_/_/
+
+Copyright (C) 2022-present
+
+This file is part of LibPacstall.
+
+LibPacstall is free software: you can redistribute it and/or modify it under the
+terms of the GNU General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version.
+
+LibPacstall is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+LibPacstall. If not, see <https://www.gnu.org/licenses/>.
+```