Skip to content
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.

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

Readme - doc, help channel #80

Merged
merged 1 commit into from
Jul 5, 2024
Merged
Changes from all commits
Commits
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
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@
<br>
</p>

## Documentation

For detailed documentation and usage instructions, please refer to the [official documentation](https://docs.curiostorage.org/).

## Overview

Curio Storage is an advanced platform designed to simplify the setup and operation of storage providers within the Filecoin ecosystem. Building on the foundation of `lotus-miner`, **Curio Storage** offers enhanced redundancy, scalability, and fault tolerance, ensuring efficient and reliable data storage solutions.
Expand Down Expand Up @@ -62,30 +66,21 @@ To get started with Curio Storage, follow these steps:
cd curio
```

2. **Switch to the Curio Branch**:
```sh
git checkout <latest release>
```

3. **Build the Project**:
2. **Build the Project**:
```sh
make clean all
```

4. **Run the Guided Setup**:
3. **Run the Guided Setup**:
```sh
curio guided-setup
```

## Documentation

For detailed documentation and usage instructions, please refer to the [official documentation](https://lotus.filecoin.io/storage-providers/curio/overview/).

## Community and Support

Join our community discussions and seek support via:

- **Slack**: [#fil-curio-dev](https://filecoinproject.slack.com/archives/C06GD1SS56Y)
- **Slack**: [#fil-curio-help](https://filecoinproject.slack.com/archives/C06LF5YP8S3)
- **GitHub Issues**: [Submit an Issue](https://github.com/filecoin-project/curio/issues/new)

## License
Expand Down