Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
updated the description and commands for locally running the docs
  • Loading branch information
RumeelHussain authored Jun 9, 2024
1 parent 9146e2a commit 3ec1b6e
Showing 1 changed file with 8 additions and 33 deletions.
41 changes: 8 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,13 @@
# Core DAO Documentation
# Core DAO Developer Documentation

This is the restructuring of Core DAO's official Docs built using [Docusaurus](https://docusaurus.io/).
Welcome to the Core DAO Developer Documentation for Core Chain! This comprehensive guide is designed to assist developers in navigating and integrating with Core Chain effectively. Whether you are looking to build decentralized applications, participate in network governance, or simply explore the capabilities of Core Chain, this documentation provides all the necessary tools and resources.

### Installation
## Commands for Local Build

```
$ npm run install
* Install depencies `npm run install `
* Start the live-reloading docs server `npm run start`
* Build the documentation site `npm run build`

OR
$ yarn
```

### Local Development

```
$ npm run start
OR
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ npm run build
OR
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
## 📜 License

Copyright (c) 2024 Core DAO

0 comments on commit 3ec1b6e

Please sign in to comment.