Update README

Abeszz · Oct 20, 2020 · 396bf51 · 396bf51
1 parent 702c293
commit 396bf51
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/.vs/HSXDCCDownloader/v16/Server/sqlite3/storage.ide-shm b/.vs/HSXDCCDownloader/v16/Server/sqlite3/storage.ide-shm
diff --git a/.vs/HSXDCCDownloader/v16/Server/sqlite3/storage.ide-wal b/.vs/HSXDCCDownloader/v16/Server/sqlite3/storage.ide-wal
diff --git a/README.md b/README.md
@@ -1,2 +1,23 @@
 # HSXDCCDownloader
  A HorribleSubs XDCC Downloader interface.
+
+# Alpha version
+ This is first working version of the program. It does not do any error handling and is solely created for my own purpose. If you would like to use it, you can still use it. Just try not to break it :)
+
+# Functions / flow
+ - Search for anime
+ - Display packlist available for the selected anime (https://xdcc.horriblesubs.info/)
+ - Downloads pack via xdcc
+
+# Important 
+ - Do not spam search. You might get banned from using the api.
+ - Do not start a new Download until all downloads have been completed. 
+
+# Libraries 
+ Please thank them for the libraries used in this project.
+ - JikanDotNet (Jikan API to fetch data from MyAnimeList)
+ - SimpleIRCLib (IRC library for connection and downloads)
+ - HorribleSubsFetcher (Fetch data from the packlist site)
+
+# TO-DO
+ - Add file directory configuration