From 7506739c1f147a0e254becc7677e2798d5068c77 Mon Sep 17 00:00:00 2001 From: Pooya Parsa Date: Mon, 5 Feb 2024 22:35:02 +0100 Subject: [PATCH] chore: update readme --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 06db08e..603cb0f 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Your automated markdown maintainer! > [!NOTE] -> This project is is erly trial stages! +> This project is in the early stages and under development. ## JSDocs Generator @@ -44,7 +44,7 @@ Now invokate `automd update`: npx automd@latest update ``` -The declarated automatically updated! +The declared section will be automatically updated: # JSRand @@ -71,12 +71,12 @@ Behind the scenes, we use [untyped](https://untyped.unjs.io/) with a [jiti](http ### Supported Args -- `src`: Path to the source file. Default is `./src/index` a and can be omited +- `src`: Path to the source file. The default is `./src/index` a and can be omitted. ## Development - Clone this repository -- Install latest LTS version of [Node.js](https://nodejs.org/en/) +- Install the latest LTS version of [Node.js](https://nodejs.org/en/) - Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable` - Install dependencies using `pnpm install` - Run playground test using `pnpm dev`