pezkuwichain/pezkuwi-runtime-templates
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-runtime-templates.git synced 2026-04-22 03:17:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

readme and docs update for monorepo (#183)

Browse Source 
* readme and docs update for monorepo

Co-authored-by: Gustavo Gonzalez <ggonzalezsomer@gmail.com>
Co-authored-by: Amar Singh <asinghchrony@protonmail.com>
This commit is contained in:
Özgün Özerk
2024-05-27 13:35:29 +03:00
committed by GitHub
parent 743eb7049e
commit 939c2cbbdd
2 changed files with 34 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+29 -3
View File
@@ -1,13 +1,39 @@
# OpenZeppelin Runtime Template for Substrate
# OpenZeppelin Runtime Templates for Substrate
Substrate has a steep learning curve. In order to make it easier for newcomers to get started, OpenZeppelin is providing runtime templates that can be used to quickly bootstrap a Substrate project.
Along with the templates, OpenZeppelin also provides a documentation website that explains the templates and the niche details.
Along with the templates, OpenZeppelin also provides a [documentation website](https://docs.openzeppelin.com/substrate-runtimes) that explains the templates and the details.
## About this repository and templates
This repository contains all of our templates. Each template has its own sub-directory, is completely standalone, and can be used independently.
For example: if you want to use our `generic runtime template`, you can just copy that subdirectory, and it will work on its own. You don't need anything from other templates nor from the root directory of this repository for your selected template to work.
---
> [!WARNING]
> Avoid using `main` for production deployments and use release branches instead. `main` is a development branch that should be avoided in favor of tagged releases. The release process involves security measures that the `main` branch does not guarantee.
### Generic Runtime Template
This template has all the basic features you expect to find on a typical L1 blockchain or parachain. Basic, yet preserving the most important pallets that are used in the Polkadot ecosystem today and a safe runtime base configuration.
You can find a full list of the pallets included in this template in our [docs](https://docs.openzeppelin.com/substrate-runtimes/1.0.0/)
### EVM template
> [!WARNING]
> EVM template is still under development.
This template has evm compatibility out of the box. You can migrate your solidity contracts or evm compatible dapps easily to your blockchain using this template.
### How to use
Please refer to our docs for a `quick start` [guide](https://docs.openzeppelin.com/substrate-runtimes/):
## Security
Past audits can be found in `/audits` directory in the respective template.
Past audits can be found in `/audits` directory in the respective template's directory.
Refer to [SECURITY.md](SECURITY.md) for more details.