From 0ccb1a36766e620eed2fb65973ff2d6c7854caf9 Mon Sep 17 00:00:00 2001 From: Alex Potsides Date: Fri, 8 Apr 2022 06:36:40 +0100 Subject: [PATCH] docs: update readme (#27) --- README.md | 2 ++ packages/protons-runtime/README.md | 2 ++ packages/protons/README.md | 2 ++ 3 files changed, 6 insertions(+) diff --git a/README.md b/README.md index 7a539e8..1f433e4 100644 --- a/README.md +++ b/README.md @@ -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`. diff --git a/packages/protons-runtime/README.md b/packages/protons-runtime/README.md index 5639077..1f0e38e 100644 --- a/packages/protons-runtime/README.md +++ b/packages/protons-runtime/README.md @@ -1,5 +1,7 @@ # protons-runtime +[![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. diff --git a/packages/protons/README.md b/packages/protons/README.md index 8e16b34..b405b2a 100644 --- a/packages/protons/README.md +++ b/packages/protons/README.md @@ -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) + > Generate typescript from .proto files ## Table of contents