Skip to content

Commit

Permalink
chore: added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bangjelkoski committed Sep 20, 2024
1 parent b5bbf3d commit 1b4309f
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 2 deletions.
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
"scripts": {
"postinstall": "node etc/bootstrapEnv",
"build": "node etc/bootstrapEnv && lerna run build",
"build:core-proto-ts": "./proto/core/gen.sh",
"generate:core-proto-ts": "./proto/core/gen.sh",
"publish:core-proto-ts": "./proto/core/publish.sh",
"build:indexer-proto-ts": "./proto/indexer/gen.sh",
"generate:indexer-proto-ts": "./proto/indexer/gen.sh",
"publish:indexer-proto-ts": "./proto/indexer/publish.sh",
"build:docs": "yarn typedoc",
"lerna:publish:prerelease": "lerna publish --conventional-commits --conventional-prerelease",
Expand Down
38 changes: 38 additions & 0 deletions proto/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# 🌟 TS Proto Generation

Within this folder we have the logic to generate proto definitions from the `injective-core` and `injective-indexer` repos. Within the `core/gen.sh` and `indexer/gen.sh` files, you can find the branches variables and change them as per your need. Then, you can simply just run `yarn generate:core-proto-ts` or `yarn generate:indexer-proto-ts` to generate the TypeScript proto definitions and finally, publish them using `yarn publish:core-proto-ts` or `yarn publish:indexer-proto-ts`

---

## 📜 Contribution

General contribution guidelines can be found on the [Contributing](CONTRIBUTING.md) page. There can be a package-specific contribution guides, please make sure you read them before you open a PR.

---

## ⛑ Support

Reach out to us at one of the following places!

- Website at <a href="https://injective.com" target="_blank">`injective.com`</a>
- Twitter at <a href="https://twitter.com/Injective_" target="_blank">`@Injective`</a>
- Discord at <a href="https://discord.com/invite/NK4qdbv" target="_blank">`Discord`</a>
- Telegram at <a href="https://t.me/joininjective" target="_blank">`Telegram`</a>

---

## 🔓 License

Copyright © 2021 - 2022 Injective Labs Inc. (https://injectivelabs.org/)

<a href="https://iili.io/mNneZN.md.png"><img src="https://iili.io/mNneZN.md.png" style="width: 300px; max-width: 100%; height: auto" />

Originally released by Injective Labs Inc. under: <br />
Apache License <br />
Version 2.0, January 2004 <br />
http://www.apache.org/licenses/

<p>&nbsp;</p>
<div align="center">
<sub><em>Powering the future of decentralized finance.</em></sub>
</div>

0 comments on commit 1b4309f

Please sign in to comment.