From 785ce9705cb69102002b81f41e8b99d1ccd7580b Mon Sep 17 00:00:00 2001 From: Muath Alsowadi <34031333+muath-ye@users.noreply.github.com> Date: Wed, 4 Dec 2024 20:00:56 +0300 Subject: [PATCH] fix(docs): improve grammar and readability in readme - Removed redundant conjunction in sentence about NestJS syntax and structure - Added hyphen to "real-world scenario" for grammatical correctness - Changed "which are" to "that are" for restrictive clause clarity - Consolidated "what not" into "whatnot" for proper word usage - Replaced repetitive "providing" with "offering" for improved readability - Added missing comma before "etc." in feature list --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 55b1c1c..63b0eeb 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ ## Introduction -Intent is a web application framework built on top of NestJS. It _intends_ to provide declarative APIs to develop and ship sophisticated solutions. While NestJS provides great syntax and structure to your application, but it lacks many things which are needed to develop a good solution. +Intent is a web application framework built on top of NestJS. It _intends_ to provide declarative APIs to develop and ship sophisticated solutions. While NestJS provides great syntax and structure to your application, it lacks many things that are needed to develop a good solution. -In a real world scenario, it is likely that you will need many things like authentication, database integration, web views and what not. This is exactly what Intent wants to solve for you. +In a real-world scenario, it is likely that you will need many things like authentication, database integration, web views, and whatnot. This is exactly what Intent aims to solve for you. -Intent aims to provide a good developer experience while providing powerful features like database integration, queue integration, event listeners, task scheduling etc. +Intent aims to provide a good developer experience while offering powerful features like database integration, queue integration, event listeners, task scheduling, etc. Intent provides necessary feature-integrations out of the box.