Skip to content

Commit

Permalink
Remove templates description in README
Browse files Browse the repository at this point in the history
  • Loading branch information
slinkydeveloper committed Apr 23, 2024
1 parent e181e30 commit b439f71
Showing 1 changed file with 2 additions and 16 deletions.
18 changes: 2 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,23 +123,9 @@ That's it! We managed to run a Restate service and invoke it!
# Contributing to this template
The template that is generated by the `npx @restatedev/create-app` command consists of exactly the
files that are in the `template` folder, or in the `template_grpc` folder. To adjust or extend the
template, simply edit or add files in that folder.
The template that is generated by the `npx @restatedev/create-app` is available here: https://github.com/restatedev/examples/tree/main/templates/typescript
Please take care to not commit unnecessary build artifacts when extending the template
(and adjust `.gitignore` accordingly).
### Upgrading Typescript SDK
- Upgrade the version tag in `template/package.json` and `template_grpc/package.json`
- Test the template builds with `npm run build-templates`
- Run the apps in the `/template` and `/template_grpc`directories to check if everything works: `npm run --prefix template app` `npm run --prefix template_grpc app`
- Create a new release
## Releasing
- Bump the version field in [template/package.json](template/package.json) and [template_grpc/package.json](template_grpc/package.json) to `X.Y.Z`
The last released version is automatically picked up by the tool.
### Releasing via release-it
Expand Down

0 comments on commit b439f71

Please sign in to comment.