google-labs-jules[bot] commited on
Commit
215727f
·
1 Parent(s): 550c088

feat: Updated README.md

Browse files

Replaced the old readme.txt with a new, comprehensive README.md that includes sections on the plugin's purpose, features, requirements, installation, configuration, usage, troubleshooting, and support.

Files changed (2) hide show
  1. README.md +97 -0
  2. readme.txt +0 -25
README.md ADDED
@@ -0,0 +1,97 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+ # Ultimate Web Novel & Manga Scraper
3
+
4
+ This WordPress plugin automatically scrapes web novels and manga from various sources and publishes them on your Madara-powered website.
5
+
6
+ ## Description
7
+
8
+ The Ultimate Web Novel & Manga Scraper is a powerful tool designed to automate the process of fetching and publishing web novels and manga. It integrates seamlessly with the Madara theme, allowing you to create a comprehensive manga and web novel site with minimal effort.
9
+
10
+ ### Key Features:
11
+
12
+ - **Automated Scraping:** Schedule automatic scraping of manga and web novels from popular sources.
13
+ - **Madara Theme Integration:** Works perfectly with the Madara theme, ensuring compatibility and a smooth user experience.
14
+ - **Multiple Scrapers:** Includes scrapers for FanFox.net, novlove.com, WuxiaWorld.site, and other Madara-based sites.
15
+ - **Advanced Scraping Options:** Configure advanced search parameters, including genres, authors, artists, and release years.
16
+ - **Content Translation:** Automatically translate scraped content using Google Translate, DeepL, or Microsoft Translator.
17
+ - **Proxy Support:** Use web proxies to avoid getting blocked while scraping.
18
+ - **Headless Browser Support:** Utilize PhantomJS, Puppeteer, or HeadlessBrowserAPI to scrape content from sites that rely on JavaScript.
19
+
20
+ ## Requirements
21
+
22
+ - **WordPress:** Version 4.0 or higher.
23
+ - **Madara Theme:** This plugin requires the [Madara - WordPress Theme for Manga](https://mangabooth.com/product/wp-manga-theme-madara/) to be installed and active.
24
+ - **Madara Core Plugin:** The Madara Core plugin, which comes with the theme, must also be active.
25
+
26
+ ## Installation
27
+
28
+ 1. **Upload Plugin:** Upload the plugin files to the `/wp-content/plugins/ultimate-manga-scraper` directory, or install the plugin through the WordPress plugins screen directly.
29
+ 2. **Activate Plugin:** Activate the plugin through the 'Plugins' screen in WordPress.
30
+ 3. **Configure Settings:** Use the **Ultimate Web Novel & Manga Scraper** -> **Main Settings** screen to configure the plugin.
31
+
32
+ ## Configuration
33
+
34
+ The plugin's settings are divided into several sections, which can be accessed from the WordPress admin menu.
35
+
36
+ ### Main Settings
37
+
38
+ - **Main Switch:** Enable or disable the entire plugin.
39
+ - **Scraping Enhancements:**
40
+ - **HeadlessBrowserAPI Key:** Enter your API key to use the HeadlessBrowserAPI for scraping JavaScript-rendered content.
41
+ - **Plugin Options:**
42
+ - **CloudFlare Caching:** Enable if your server uses CloudFlare to avoid issues with execution time limits.
43
+ - **Manga Storage Device:** Select the storage location for scraped manga (local, Amazon S3, etc.).
44
+ - **Logging:** Enable or disable logging for scraping rules.
45
+ - **Automatic Rerunning of Rules:** Disable to prevent the plugin from automatically restarting a failed scraping process.
46
+ - **Proxy Settings:** Configure your web proxy address and authentication details.
47
+ - **Timeouts and Delays:** Set timeouts for rule execution and delays between scraping requests.
48
+ - **Translation Options:**
49
+ - **Translator API Keys:** Enter your API keys for Google Translator, Microsoft Translator, or DeepL.
50
+ - **PhantomJS Settings:**
51
+ - **PhantomJS Path:** Set the server path for the PhantomJS executable.
52
+ - **Execution Timeout:** Configure the timeout for PhantomJS execution.
53
+
54
+ ### Scraping Rules
55
+
56
+ You can create and manage scraping rules for different sources:
57
+
58
+ - **Manga Scraper (FanFox.net)**
59
+ - **Web Novel Scraper (novlove.com)**
60
+ - **Web Novel Scraper (WuxiaWorld.site)**
61
+ - **Manga Scraper (Madara Theme Sites)**
62
+ - **Web Novel Scraper (Madara Theme Sites)**
63
+
64
+ Each rule allows you to specify the manga or web novel to scrape (by URL or keyword), set a scraping schedule, define the number of chapters to fetch, and configure various other options.
65
+
66
+ ## Usage
67
+
68
+ 1. **Navigate to the Plugin Settings:** In your WordPress dashboard, go to **Ultimate Web Novel & Manga Scraper**.
69
+ 2. **Configure Main Settings:** Set up your API keys, proxy settings, and other global options in the **Main Settings** tab.
70
+ 3. **Create a Scraping Rule:**
71
+ - Go to one of the scraper sections (e.g., **Manga Scraper (FanFox.net)**).
72
+ - Enter the URL or search keyword for the manga you want to scrape.
73
+ - Set the scraping schedule (in hours or minutes).
74
+ - Configure other options, such as the number of chapters to scrape, post status, and author.
75
+ - Save the rule.
76
+ 4. **Run the Rule:** You can either wait for the rule to run on its schedule or trigger it manually by clicking the "Run This Rule Now" button.
77
+
78
+ ## Troubleshooting
79
+
80
+ - **Scraping Failures:** If a scraping rule fails, check the **Activity & Logging** tab for detailed error messages.
81
+ - **CloudFlare Issues:** If your site is behind CloudFlare, make sure to enable the "My Server Is Using CloudFlare Caching" option in the Main Settings.
82
+ - **JavaScript-Rendered Content:** If you're scraping a site that uses JavaScript to load content, use one of the headless browser options (PhantomJS, Puppeteer, or HeadlessBrowserAPI).
83
+
84
+ ## Support
85
+
86
+ If you need help with the plugin, please check our [knowledge base](//coderevolution.ro/knowledge-base/) or contact [our support team](//coderevolution.ro/support).
87
+
88
+ ## Changelog
89
+
90
+ ### 2.0.3
91
+ - Added Nulled Version.
92
+
93
+ ### 2.0.2
94
+ - Bugfixes and performance improvements.
95
+
96
+ ### 1.0
97
+ - Initial release.
readme.txt DELETED
@@ -1,25 +0,0 @@
1
- === Ultimate Web Novel & Manga Scraper Plugin for WordPress ===
2
- Contributors: coderevolution
3
- Donate link: https://www.patreon.com/coderevolution
4
- Tags: popup, subscribers
5
- Requires at least: 4.0
6
- Tested up to: 6.8.0
7
- Stable tag: 6.7.1
8
- License: License-Free
9
-
10
- Another plugin made by CodeRevolution.
11
-
12
- == Description ==
13
-
14
- This plugin will scrape manga for you, day and night.
15
-
16
- == Installation ==
17
-
18
- 1. Upload the plugin files to the `/wp-content/plugins/plugin-name` directory, or install the plugin through the WordPress plugins screen directly.
19
- 2. Activate the plugin through the 'Plugins' screen in WordPress
20
- 3. Use the Settings->Plugin Name screen to configure the plugin
21
-
22
- == Changelog ==
23
-
24
- = 1.0 =
25
- Initial release