65 lines
2.5 KiB
Markdown
65 lines
2.5 KiB
Markdown
|
|
# protons-runtime <!-- omit in toc -->
|
||
|
|
|
||
|
|
[](https://ipfs.tech)
|
||
|
|
[](https://discuss.ipfs.tech)
|
||
|
|
[](https://codecov.io/gh/ipfs/protons)
|
||
|
|
[](https://github.com/ipfs/protons/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
|
||
|
|
|
||
|
|
> Shared code to make your bundle smaller when running protons in your app
|
||
|
|
|
||
|
|
# About
|
||
|
|
|
||
|
|
<!--
|
||
|
|
|
||
|
|
!IMPORTANT!
|
||
|
|
|
||
|
|
Everything in this README between "# About" and "# Install" is automatically
|
||
|
|
generated and will be overwritten the next time the doc generator is run.
|
||
|
|
|
||
|
|
To make changes to this section, please update the @packageDocumentation section
|
||
|
|
of src/index.js or src/index.ts
|
||
|
|
|
||
|
|
To experiment with formatting, please run "npm run docs" from the root of this
|
||
|
|
repo and examine the changes made.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
This module contains serialization/deserialization code used when encoding/decoding protobufs.
|
||
|
|
|
||
|
|
It should be declared as a dependency of your project:
|
||
|
|
|
||
|
|
```console
|
||
|
|
npm i protons-runtime
|
||
|
|
```
|
||
|
|
|
||
|
|
# Install
|
||
|
|
|
||
|
|
```console
|
||
|
|
$ npm i protons-runtime
|
||
|
|
```
|
||
|
|
|
||
|
|
Contains shared code to reduce code duplication between modules transpiled by protons.
|
||
|
|
|
||
|
|
# API Docs
|
||
|
|
|
||
|
|
- <https://ipfs.github.io/protons/modules/protons_runtime.html>
|
||
|
|
|
||
|
|
# License
|
||
|
|
|
||
|
|
Licensed under either of
|
||
|
|
|
||
|
|
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
|
||
|
|
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
|
||
|
|
|
||
|
|
# Contribute
|
||
|
|
|
||
|
|
Contributions welcome! Please check out [the issues](https://github.com/ipfs/protons/issues).
|
||
|
|
|
||
|
|
Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
|
||
|
|
|
||
|
|
Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
|
||
|
|
|
||
|
|
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
|
||
|
|
|
||
|
|
[](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
|