README.md

@@ -1,68 +1,48 @@
 # What's this?
 
-This repository contains database of all quotes from the famous website bash.im
+This repository contains database of all quotes from the famous website bash.im as well as the API that allows self-hosting your own quotes website.  
-as well as the API that allows self-hosting your own quotes website. All of
+All of this started in February 2022 when bash.im was shut down.  
-this started in February 2022 when bash.im was shut down. Quotes were parsed
+Quotes were parsed from the web archive.  
-from the web archive.
-
 # Requirements
-
 - Python 3.8+ (Python 3.11 is recommended)
 - Git LFS for fetching the quotes DB
 
 # Quickstart
-
+```
-```bash
+# Clone this repository and enter it:  
-# Clone this repository and enter it:
+git clone https://git.darkn.space/Darkn/bash-fastapi.git  
-git clone https://git.darkn.space/Darkn/bash-fastapi.git
+# Download the quotes.sqlite3 using Git LFS and replace the pointer file with the actual database:  
-cd bash-fastapi
+git lfs pull  
-# Download the quotes.sqlite3 using Git LFS
+# Configure virtualenv:  
-# and replace the pointer file with the actual database:
+python3 -m venv .venv  
-git lfs pull
+# Activate virtualenv:  
-# Configure virtualenv:
+. .venv/bin/activate  
-python3 -m venv .venv
+# Install dependencies:  
-# Activate virtualenv:
+python3 -m pip install -r requirements.txt  
-. .venv/bin/activate
+# Start main.py  
-# Install dependencies:
+python main.py  
-python3 -m pip install -r requirements.txt
-# Start main.py
-python main.py
 ```
 
 # FAQ
+### How do I change the port on which API runs?
+Default port is 8001, but you can change it inside of main.py by modifying those lines at the very end:
 
-**Q: How do I change the port on which API runs?**
+```python3
-
-A: Default port is 8001, but you can change it inside of main.py by modifying
-those lines at the very end:
-
-```python
 if __name__ == "__main__":
     uvicorn.run(app, port=8001, host="0.0.0.0")
 ```
 
-**Q: Why is quotes.sqlite3 so small and has no quotes inside of it after I
+### Why is quotes.sqlite3 so small and has no quotes inside of it after I cloned your repository?
-cloned your repository?**
+You probably forgot to install and/or use Git LFS. Go to the repository directory and run following commands:  
-
+```
-A: You probably forgot to install and/or use Git LFS. Go to the repository
-directory and run following commands:
-
-```bash
 git lfs install
 git lfs fetch
 git lfs checkout
 ```
-
+You can read more about using Git LFS [here](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage) and [here](https://stackoverflow.com/questions/72610494/what-is-the-difference-between-git-lfs-fetch-git-lfs-fetch-all-and-git).
-You can read more about using Git LFS
+### Do you really have all quotes from bash.im?
-[here](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage)
+As long as it was indexed by the web archive, it's there.  
-and
-[here](https://stackoverflow.com/questions/72610494/what-is-the-difference-between-git-lfs-fetch-git-lfs-fetch-all-and-git).
-
-**Q: Do you really have all quotes from bash.im?**
-
-A: As long as it was indexed by the web archive, it's there.
 
 # Credits:
 
-Thanks to ~~The Man, the Myth, the Legend~~ the Darkn member gameeroor for
+Thanks to ~~The Man, the Myth, the Legend~~ the Darkn member gameeroor for helping with parsing and making such a nice API.
-helping with parsing and making such a nice API.