aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md91
1 files changed, 91 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b3ba01a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,91 @@
+# meow
+
+Search nyaa (or any proxy/mirrors) with web scraping.
+
+``` go
+package main
+
+import (
+ "fmt"
+ "vidhukant.com/meow"
+)
+
+func main() {
+ q := meow.SearchQuery {
+ SearchString: "mushishi",
+
+ BaseURL: "nyaa.si", // default
+ Filter: 0, // none (default)
+ Category: meow.CategoryAll, // default
+ Page: 1, // default (range 1-100)
+ }
+
+ res, err := meow.Search(q)
+ if err != nil {
+ panic(err)
+ }
+
+ for i, _ := range res {
+ fmt.Println(i.Title)
+ fmt.Println(i.Category)
+ fmt.Println(i.Flag)
+ fmt.Println(i.URL)
+ fmt.Println(i.TorrentURL)
+ fmt.Println(i.MagnetURL)
+ fmt.Println(i.FileSize)
+ fmt.Println(i.TimeStamp)
+ fmt.Println(i.Seeders)
+ fmt.Println(i.Leechers)
+ fmt.Println(i.Downloads)
+ }
+}
+```
+
+## Available categories
+
+Pretty self explanatory
+
+- `CategoryAll`
+
+- `CategoryAnime`
+- `CategoryAnimeAMV`
+- `CategoryAnimeEnglish`
+- `CategoryAnimeNonEnglish`
+- `CategoryAnimeRaw`
+
+- `CategoryAudio`
+- `CategoryAudioLossless`
+- `CategoryAudioLossy`
+
+- `CategoryLiterature`
+- `CategoryLiteratureEnglish`
+- `CategoryLiteratureNonEnglish`
+- `CategoryLiteratureRaw`
+
+- `CategoryLiveAction`
+- `CategoryLiveActionEnglish`
+- `CategoryLiveActionIdolPV`
+- `CategoryLiveActionNonEnglish`
+- `CategoryLiveActionRaw`
+
+- `CategoryPictures`
+- `CategoryPicturesGraphics`
+- `CategoryPicturesPhotos`
+
+- `CategorySoftware`
+- `CategorySoftwareApps`
+- `CategorySoftwareGames`
+
+## Available filters
+
+- `FilterNone`
+- `FilterNoRemakes`
+- `FilterTrustedOnly`
+
+# License
+
+Licenced under GNU General Public Licence
+
+GNU GPL License: [LICENSE](https://git.vidhukant.com/meow/tree/LICENSE)
+
+Copyright (c) 2024 Vidhu Kant Sharma