Skip to content

docs: update readme #216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
hexjelly wants to merge 1 commit into from
Closed

docs: update readme #216

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,11 @@ Install dependencies
pnpm install
```

Adding a new dependency to a specific package:
```
pnpm add <dependency> --filter las-sdk-core
```

Build
```
pnpm run build
Expand All @@ -55,6 +60,12 @@ Run tests
pnpm run test
```

Most of the work will be done within the `las-sdk-core` package in the workspace. Unless there is a major architecture change to the setup, you probably will never need to work with the other packages.

### Creating a new method

- Add new method to `Client` in `packages/las-sdk-core/src/client.ts`
- Add new test file like `packages/las-sdk-core/src/client.fooBarMethod.spec.ts`

## Release process

Expand Down