From 7f61f91f4ee7cf1a33bd5ae8f2f9472de33fe05e Mon Sep 17 00:00:00 2001 From: Jay-Karia Date: Sat, 3 Aug 2024 14:24:23 +0530 Subject: [PATCH 1/3] docs: add setup guide --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 4cbfcc5..cc4caa4 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,28 @@ export default function convert (str: string, to: 'npm' | 'yarn' | 'pnpm' | 'bun Tests can be run with `npm test`. Multiple tests check that parsing, rendering, and compiling return expected results, formatting follows guidelines, and code coverage is at the expected level. +## 📦 Setup Guide + +Install Dependencies +```sh copy +npm install +``` + +Run the development server + +```sh +npm run start +``` + +A new file: `npm-to-yarn.mjs` is created in `dist` folder.
+Open node inside the terminal and write the following code to test new changes +```js +const npmToYarn = await import("./dist/npm-to-yarn.mjs") +const convert = npmToYarn.default + +convert("npm install react", "bun") +``` + ## Resources To be added From 004402aa7da7cfb852a29f0b93a65f1cc850eed8 Mon Sep 17 00:00:00 2001 From: Jay Date: Tue, 13 Aug 2024 14:45:59 +0530 Subject: [PATCH 2/3] chore: rename section --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cc4caa4..31a9091 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ export default function convert (str: string, to: 'npm' | 'yarn' | 'pnpm' | 'bun Tests can be run with `npm test`. Multiple tests check that parsing, rendering, and compiling return expected results, formatting follows guidelines, and code coverage is at the expected level. -## 📦 Setup Guide +## 📦 Contributing to npm-to-yarn - Setup Guide Install Dependencies ```sh copy From ad3bb7a2f69ff0f68d1ff59fae4980444b015460 Mon Sep 17 00:00:00 2001 From: Jay Date: Wed, 14 Aug 2024 00:13:02 +0530 Subject: [PATCH 3/3] chore: add code blocks --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 31a9091..28b0aba 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ export default function convert (str: string, to: 'npm' | 'yarn' | 'pnpm' | 'bun Tests can be run with `npm test`. Multiple tests check that parsing, rendering, and compiling return expected results, formatting follows guidelines, and code coverage is at the expected level. -## 📦 Contributing to npm-to-yarn - Setup Guide +## 📦 Contributing to `npm-to-yarn` - Setup Guide Install Dependencies ```sh copy @@ -65,7 +65,7 @@ npm run start ``` A new file: `npm-to-yarn.mjs` is created in `dist` folder.
-Open node inside the terminal and write the following code to test new changes +Open `node` inside the terminal and write the following code to test new changes ```js const npmToYarn = await import("./dist/npm-to-yarn.mjs") const convert = npmToYarn.default