Skip to content

Commit 725df85

Browse files
authored
Add README.md f
1 parent a0d5212 commit 725df85

File tree

2 files changed

+57
-0
lines changed

2 files changed

+57
-0
lines changed

README.md

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Ryokai
2+
3+
## Intro
4+
5+
`Ryokai` is the **new orchestrator tool** from [KiraCore team](https://github.com/KiraCore/).
6+
7+
> `RYOKAI` 了解 (りょかい), previously known as KIRA Manager, is KIRA’s orchestration tool, a physical infrastructure manager
8+
> that facilitates backend operations of KIRA stack components for Consensus nodes. It automates critical processes
9+
> such as [`KiraCore/sekai`](https://github.com/KiraCore/sekai) system upgrades, auto-deployment of containerized Layer 2 applications,
10+
> and [`KiraCore/interx`](https://github.com/KiraCore/interx) configuration.
11+
> The integration with [`hashicorp/vault`](https://github.com/hashicorp/vault) enhances `RYOKAI`'s capabilities,
12+
> providing robust security features for secrets management and access control.
13+
14+
Check out the documentation:
15+
<https://docs.kira.network/learn/2ac3bfb7-478c-4207-a290-051d9fa6124f/>
16+
17+
![ryokai](img/ryokai.png)
18+
19+
## Table of Contents
20+
21+
- [Ryokai](#ryokai)
22+
- [Intro](#intro)
23+
- [Table of Contents](#table-of-contents)
24+
- [Getting started](#getting-started)
25+
- [Prerequisites](#prerequisites)
26+
- [Installation](#installation)
27+
- [Usage](#usage)
28+
- [Contributing](#contributing)
29+
- [FAQs](#faqs)
30+
31+
## Getting started
32+
33+
**TODO:** List of steps for getting started
34+
35+
### Prerequisites
36+
37+
**TODO:** List any prerequisites required to run the project, such as software versions, environment setup, etc.
38+
39+
### Installation
40+
41+
**TODO:** Step-by-step instructions to get a development environment running. Include commands to clone the project, install dependencies, and any other necessary steps to get started.
42+
43+
## Usage
44+
45+
**TODO:** Detailed examples of how to use the project, including code snippets and command line instructions.
46+
47+
## Contributing
48+
49+
We welcome contributions! Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
50+
51+
## FAQs
52+
53+
**TODO:**
54+
55+
> Q: What is the project?
56+
>
57+
> A: This project is responsible to automate the orchestration of containers from different sources.

img/ryokai.png

2.53 MB
Loading

0 commit comments

Comments
 (0)