Skip to content

Commit

Permalink
docs: update readme (#27)
Browse files Browse the repository at this point in the history
  • Loading branch information
achingbrain authored Apr 8, 2022
1 parent 398f066 commit 0ccb1a3
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# protons

[![test & maybe release](https://github.com/ipfs/protons/actions/workflows/js-test-and-release.yml/badge.svg)](https://github.com/ipfs/protons/actions/workflows/js-test-and-release.yml)

> `.proto` to `.ts` transpiler
Transpiles `.proto` files to `.ts` - uses `Uint8Array` for `byte` fields and `BigInt` for `int64`/`uint64` and `sint64`.
Expand Down
2 changes: 2 additions & 0 deletions packages/protons-runtime/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# protons-runtime <!-- omit in toc -->

[![test & maybe release](https://github.com/ipfs/protons/actions/workflows/js-test-and-release.yml/badge.svg)](https://github.com/ipfs/protons/actions/workflows/js-test-and-release.yml)

> Shared components that turn values to bytes and back again
Contains shared code to reduce code duplication between modules transpiled by protons.
Expand Down
2 changes: 2 additions & 0 deletions packages/protons/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# protons <!-- omit in toc -->

[![test & maybe release](https://github.com/ipfs/protons/actions/workflows/js-test-and-release.yml/badge.svg)](https://github.com/ipfs/protons/actions/workflows/js-test-and-release.yml)

> Generate typescript from .proto files
## Table of contents <!-- omit in toc -->
Expand Down

0 comments on commit 0ccb1a3

Please sign in to comment.