From 8f518cde3e178642b1822be2187fe4b561879d80 Mon Sep 17 00:00:00 2001 From: John Kevin Umali <54800909+Kevin-Umali@users.noreply.github.com> Date: Wed, 6 Mar 2024 23:40:41 +0800 Subject: [PATCH] Update README.md --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4df5b24..463d827 100644 --- a/README.md +++ b/README.md @@ -5,18 +5,18 @@ ![Puppeteer](https://img.shields.io/badge/Puppeteer--blue?style=for-the-badge) ![Zod](https://img.shields.io/badge/Zod--blue?style=for-the-badge) -**An upgraded REST API for light, wuxia, and web novels, now powered by Fastify and Puppeteer for improved performance and reliability.** +**An upgraded REST API for light, wuxia, and web novels, now powered by Fastify and Puppeteer for improved performance and reliability. Designed for educational and study purposes, this project showcases advanced web scraping, API development, and data validation techniques.** ## What's New in the Enhanced Edition - **Upgraded Tech Stack**: Transitioned from Express to Fastify for faster, more efficient server handling. -- **Advanced Scraping with Puppeteer**: Enhanced data scraping capabilities for more accurate and up-to-date novel information. -- **Improved Data Validation with Zod**: Robust data validation and schema management to ensure data integrity. -- **Optimized Performance**: Significant performance improvements for a smoother and faster user experience. +- **Advanced Scraping with Puppeteer**: Utilizes Puppeteer for enhanced data scraping capabilities, ensuring accurate and up-to-date novel information. +- **Improved Data Validation with Zod**: Incorporates Zod for robust data validation and schema management, enhancing data integrity. +- **Optimized Performance**: Achieves significant performance improvements, offering a smoother and faster user experience. ## Available Sources -I will continuously expand this library time to time. Here are the current sources: +We are continuously expanding this library. Here are the current supported sources: | Site | Can Search | Status | | -------------------------- | :--------: | :----: | @@ -26,12 +26,14 @@ I will continuously expand this library time to time. Here are the current sourc | https://novelfull.com/ | | ⌛ | | https://novelnext.com/ | | ⌛ | -## Using Version 1 (v1) of the API +## Disclaimer and Purpose -For those who are still interested in using version 1 of my API, it remains accessible and functional. You can find all the relevant documentation and resources for version 1 at the following GitHub branch: [Novel API v1](https://github.com/Kevin-Umali/novel-api/tree/v1). +This project and all associated code and documentation are intended **solely for educational and study purposes**. It serves as a practical example of web scraping, API design, and data handling techniques. It is not intended for commercial use or deployment in production environments. The creators and contributors assume no liability for any misuse of the project or any damages resulting from its use. Users are expected to adhere to these guidelines and use the project responsibly. -Please note that while v1 is still available, it may not receive the same level updates, or feature enhancements as the latest version. I encourage users to use to the current version for the most up-to-date features and improvements. +## Legacy Version + +Version 1 (v1) of the API remains accessible and functional, with documentation available at: [Novel API v1](https://github.com/Kevin-Umali/novel-api/tree/v1). Note: v1 may not receive updates or feature enhancements available in the latest version. Users are encouraged to migrate to the current version for the most up-to-date features and improvements. ## Contribute -Found a bug or have a feature request? Feel free to open an issue or submit a pull request on our [GitHub repository](https://github.com/Kevin-Umali/novel-api/issues). +We welcome contributions! If you've found a bug or have a feature request, feel free to open an issue or submit a pull request on our [GitHub repository](https://github.com/Kevin-Umali/novel-api/issues).