Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
  • Loading branch information
pyramation committed Apr 18, 2024
1 parent 2479d78 commit 50154a8
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 308 deletions.
24 changes: 21 additions & 3 deletions boilerplates/telescope/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ npm install __PACKAGE_IDENTIFIER__
- [Broadcasting Messages](#broadcasting-messages)
- [Advanced Usage](#advanced-usage)
- [Developing](#developing)
- [Codegen](#codegen)
- [Publishing](#publishing)
- [Related](#related)
- [Credits](#credits)

## Usage
Expand Down Expand Up @@ -266,21 +269,36 @@ yarn build

### Codegen

Contract schemas live in `./contracts`, and protos in `./proto`. Look inside of `scripts/codegen.js` and configure the settings for bundling your SDK and contracts into `__PACKAGE_IDENTIFIER__`:
Look inside of `scripts/codegen.ts` and configure the settings for bundling your SDK and contracts into `__PACKAGE_IDENTIFIER__`:

```
yarn codegen
```

### Publishing

Build the types and then publish:
To publish, use `lerna`:

```
lerna publish
```

You can publish patch, minor, or major versions:

```
lerna publish minor
```

If you absolutely need to publish manually using npm, ensure to do it this way, and publish from the `dist/` directory for proper tree-shaking module paths:

```
cd ./packages/<your-telescope-module>
yarn build
yarn publish
cd dist
npm publish
```


## Related

Checkout these related projects:
Expand Down
305 changes: 0 additions & 305 deletions boilerplates/telescope/packages/telescope/README.md

This file was deleted.

0 comments on commit 50154a8

Please sign in to comment.