Skip to content

Commit 5576a28

Browse files
Update README.md
1 parent 806c2bb commit 5576a28

1 file changed

Lines changed: 8 additions & 36 deletions

File tree

README.md

Lines changed: 8 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,13 @@
1-
# Website
1+
# Core DAO Developer Documentation
22

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
3+
Welcome to the Core Developer Documentation for the Core blockchain! This comprehensive guide is designed to assist developers in navigating and integrating with Core blockchain effectively. Whether you are looking to build decentralized applications, participate in network governance, or simply explore the capabilities of Core blockchain, this documentation provides all the necessary tools and resources.
44

5-
## Installation
5+
## Commands for Local Build
66

7-
```bash
8-
yarn
9-
```
7+
* Install depencies `yarn install `
8+
* Start the live-reloading docs server `yarn run start`
9+
* Build the documentation site `yarn run build`
1010

11-
## Local Development
11+
## 📜 License
1212

13-
```bash
14-
yarn start
15-
```
16-
17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18-
19-
## Build
20-
21-
```bash
22-
yarn build
23-
```
24-
25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26-
27-
## Deployment
28-
29-
Using SSH:
30-
31-
```bash
32-
USE_SSH=true yarn deploy
33-
```
34-
35-
Not using SSH:
36-
37-
```bash
38-
GIT_USER=<Your GitHub username> yarn deploy
39-
```
40-
41-
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.
13+
Copyright (c) 2024 Core DAO

0 commit comments

Comments
 (0)