update readme

README.md

@@ -13,15 +13,39 @@
 **Table of Contents**
 
 - [Aniwrapper](#aniwrapper)
+- [Introduction](#introduction)
 - [Setup](#setup)
   - [Dependencies](#dependencies)
     - [Arch Linux](#arch-linux)
-  - [Usage](#usage)
+  - [Installing](#installing)
-    - [aniwrapper](#aniwrapper)
+- [Usage](#usage)
-    - [ani-cli Script](#ani-cli-script)
+  - [aniwrapper](#aniwrapper)
+  - [ani-cli Script](#ani-cli-script)
+- [Screenshots](#screenshots)
 
 <!-- markdown-toc end -->
 
+# Introduction
+
+This is a fork of [Dink4n's ani-cli](https://github.com/Dink4n/ani-cli),
+which itself is a fork of
+pystardust's [old-ani-cli](https://github.com/pystardust/ani-cli/tree/old-ani-cli)
+
+This fork is a wrapper around a modified version of ani-cli
+and uses [rofi](https://github.com/davatorium/rofi) to gather information and control the program
+
+In addition to `rofi`, I've also changed the way saving history works by
+integrating a local [sqlite3](https://www.sqlite.org/index.html) database with a table for
+search and watch history
+
+It is built around Dink4n's fork of ani-cli since at the time of
+creation, this is the version that has downloading working correctly
+
+This tool scrapes the site [gogoanime](https://gogoanime.vc).
+
+It is intended to be called from the wrapper script `aniwrapper`,
+however using the ani-cli script itself is also possible
+
 # Setup
 
 ## Dependencies
@@ -51,35 +75,31 @@ git clone https://github.com/ksyasuda/aniwrapper
 cd aniwrapper
 ```
 
-After cloning the repository
+After cloning and switching into the `aniwrapper` directory, run the following commands to set up and install the script
 
-This is a fork of [Dink4n's ani-cli](https://github.com/Dink4n/ani-cli),
+```sh
-which itself is a fork of
+chmod +x setup.sh
-pystardust's [old-ani-cli](https://github.com/pystardust/ani-cli/tree/old-ani-cli)
+./setup.sh && sudo make install
+```
 
-This fork is a wrapper around a modified version of ani-cli
+The setup process consists of:
-and uses [rofi](https://github.com/davatorium/rofi) to gather information and control the program
 
-In addition to `rofi`, I've also changed the way saving history works by
+- Creating the necessary configuration directories (if they don't already exist)
-integrating a local [sqlite3](https://www.sqlite.org/index.html) database with a table for
+  - Aniwrapper config:`$XDG_CONFIG_HOME/aniwrapper/`
-search and watch history
+  - mpv config:`$XDG_CONFIG_HOME/mpv/`
+- Moving the configuration files and scripts to their respective directories
+- Creating the `sqlite3` database with tables for search and watch history
 
-It is built around Dink4n's fork of ani-cli since at the time of
+Running `sudo make install` copies the `ani-cli` as well as the `aniwrapper` scripts to `/usr/local/bin/`
-creation, this is the version that has downloading working correctly
 
-This tool scrapes the site [gogoanime](https://gogoanime.vc).
+# Usage
 
-It is intended to be called from the wrapper script `aniwrapper`,
+## aniwrapper
-however using the ani-cli script itself is also possible
-
-## Usage
-
-### aniwrapper
 
     # Launch aniwrapper menu
     aniwrapper
 
-### ani-cli Script
+## ani-cli Script
 
     # watch anime
     ani-cli <query>
@@ -107,3 +127,15 @@ Multiple episodes can be viewed/downloaded by giving the episode range like so
     Choose episode [1-13]: 1 6
 
 This would open/download episodes 1 2 3 4 5 6
+
+# Screenshots
+
+<div align="center">
+
+Aniwrapper Main Menu
+![aniwrapper frontpage](./screenshots/aniwrapper_home.png)
+Aniwrapper Streaming Menu
+![aniwrapper streaming options](./screenshots/aniwrapper_stream.png)
+Move to come soon... maybe
+
+</div>