Skip to content

Update README.md #2950

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #2950

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
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,18 @@ security-sensitive bugs privately.
For non-security bugs, please use the [regular Issues
page](https://github.com/Agoric/SES-shim/issues).

## Contributing

This repository uses lerna as a monorepo, to allow the included packages to depend on each other.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the cross-package linking is a yarn feature and the tooling for publishing is facilitated by lerna, but the boundary is vague in my mind.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And maybe link CONTRIBUTING.md.


To get started after pulling the repository, to get started, in the root directory run:

```
corepack enable
yarn install
```
You should then be able to navigate to the package you're interested in and use it directly.

### License

Endo and its components are [Apache 2.0 licensed][license-url].
Expand Down
Loading