From 172e8ca13f378fa10a117150a2396c53c17daa63 Mon Sep 17 00:00:00 2001 From: techchud Date: Sun, 17 Aug 2025 19:35:25 -0500 Subject: readme added --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..faa8f54 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# Stashley + +Stashley is a program used for archiving personalities using TOML files, and if IPFS is installed, pushing them to IPFS. + +The format for files is as follows: + +``` +name=PersonalityName + +[socialMedia] +urls=["example.com", "example.org"] +``` + +A filled example is as follows: + +``` +name="Sashley" + +[toyhouse] +urls=["https://toyhou.se/sashley/art"] + +[instagram] +urls=["https://www.instagram.com/sxshley"] + +[misskey] +urls=["https://fedi.fazbear.lol/@sxshely"] + +[youtube] +urls = ["https://www.youtube.com/channel/UCO86mBfqBTsfEUnPvJ4s1bg", "https://www.youtube.com/channel/UC35UExRBy6pkawgvClaws2Q"] + +[twitter] +urls=["https://twitter.com/sxshely", "https://twitter.com/BUNNIIYE", "https://twitter.com/_atsukix"] +``` + +## Supported Websites + +stashley uses [yt-dlp](https://github.com/yt-dlp/yt-dlp), [gallery-dl](https://github.com/mikf/gallery-dl/), and GNU's wget to do the actual archiving work. Because of this, anything supported by those programs is something stashley will support. More extractors will be added as needed. -- cgit v1.2.3