Skip to content

Commit

Permalink
feat(components): add readme for npm link
Browse files Browse the repository at this point in the history
  • Loading branch information
maximeperrault authored and maximeperraultdev committed Jul 1, 2024
1 parent 910a367 commit 5193a5b
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,37 @@ export function App() {

Here is [the Storybook documentation][lnk-documentation].

## Testing in your project

### Using npm link

1. Globally link your module

```bash
npm link
```

2. Link the module in a project

```bash
cd /path/to/my-project
```

Add to `dependencies` ` "@mtes-mct/monitor-ui__root": "<version>",` to `package.json`

```bash
npm link @mtes-mct/monitor-ui__root
```

3. Unlink the module:

```bash
cd /path/to/my-project
npm unlink my-module
cd /path/to/my-module
npm unlink
```

## Contributing

Please read the [contributing document](CONTRIBUTING.md) for setup and contributing instructions.
Expand Down

0 comments on commit 5193a5b

Please sign in to comment.