Skip to content

Commit

Permalink
docs: add setup guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Jay-Karia committed Aug 3, 2024
1 parent a22a52d commit 7f61f91
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. <br>
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
Expand Down

0 comments on commit 7f61f91

Please sign in to comment.