Skip to content

Revise README: usage examples, contributor tips, contact link #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
0x4543 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Revise README: usage examples, contributor tips, contact link #76

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 24 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,37 @@ Helios Portal is the official entry point to the Helios Blockchain, providing us
## Getting Started

### Clone the Repository
```sh

```bash
git clone https://github.com/helios-network/helios-portal.git
cd helios-portal
```

### 2Install Dependencies
```sh
### Install Dependencies

```bash
npm install # or yarn install
```

### 3Run the Development Server
```sh
### Run the Development Server

```bash
npm run dev # or yarn dev
```

## Documentation

For detailed setup instructions, API references, and user guides, refer to the official documentation on Helios Hub.


## Usage Examples

- **Bridging Assets**: Navigate to the 'Bridge' section and follow the on-screen instructions to move tokens between chains.
- **Staking Tokens**: Open the 'Staking' tab, select a validator, and stake your tokens.
- **Delegation**: Delegate your voting power to a validator for governance participation.
- **Portfolio Tracking**: View your balances, staking rewards, and governance votes directly in the dashboard.


## Contributing

We welcome contributions! To contribute:
Expand All @@ -43,13 +55,19 @@ We welcome contributions! To contribute:
4. Push the branch (`git push origin feature-name`).
5. Open a pull request.

**Tips for contributors:**

- Add meaningful comments and explanations for any new features.
- Update the README or documentation for any added functionality.
- Ensure that code follows existing formatting and style guidelines.

## License

This project is licensed under the MIT License.

## Contact

For questions or support, join our community or reach out to the Helios team.
For questions or support, join our community or reach out to the Helios team via [Helios Blockchain Linktree](https://linktr.ee/heliosblockchain).

---

Expand Down