Skip to content

Commit f4e80c7

Browse files
author
Sean Katz
committed
Add repo description and basic installation guidance
1 parent 5754e92 commit f4e80c7

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

+22
Original file line numberDiff line numberDiff line change
@@ -1 +1,23 @@
1+
# Welcome to Lava Docs 📕
2+
This repository contains documentation for Lava.
3+
The source is generated to [Lava Docs website](https://docs.lavanet.xyz/), but can also be browsed as plain source in the [Docs folder](/docs/).
4+
5+
## Installation
6+
```
7+
$ yarn install
8+
```
9+
Local Development
10+
```
11+
$ yarn start
12+
```
13+
Build
14+
```
15+
$ yarn build
16+
```
17+
Deployment:
18+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
19+
20+
```
21+
$ GIT_USER=<Your GitHub username> yarn deploy
22+
```
123

0 commit comments

Comments
 (0)