From dc6e58b17cf62931236c525b1ce5dd565c684f1f Mon Sep 17 00:00:00 2001 From: David Dias Date: Tue, 28 Jul 2020 15:17:54 +0200 Subject: [PATCH] docs: small readme update --- README.md | 30 +++++++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d8550748d..eec288573 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ -![Lotus](documentation/images/lotus_logo_h.png) +

+ + Project Lotus Logo + +

-# Project Lotus - 莲 +

Project Lotus - 莲

-Lotus is an implementation of the Filecoin Distributed Storage Network. For more details about Filecoin, check out the [Filecoin Spec](https://github.com/filecoin-project/specs). +Lotus is an implementation of the Filecoin Distributed Storage Network. For more details about Filecoin, check out the [Filecoin Spec](https://spec.filecoin.io). ## Building & Documentation @@ -14,13 +18,29 @@ Please send an email to security@filecoin.org. See our [security policy](SECURIT ## Development -All work is tracked via issues. An attempt at keeping an up-to-date view on remaining work is in the [lotus testnet github project board](https://github.com/filecoin-project/lotus/projects/1). - The main branches under development at the moment are: * [`master`](https://github.com/filecoin-project/lotus): current testnet. * [`next`](https://github.com/filecoin-project/lotus/tree/next): working branch with chain-breaking changes. * [`ntwk-calibration`](https://github.com/filecoin-project/lotus/tree/ntwk-calibration): devnet running one of `next` commits. +### Tracker + +All work is tracked via issues. An attempt at keeping an up-to-date view on remaining work is in the [lotus github project board](https://github.com/orgs/filecoin-project/projects/8). + +### Packages + +The lotus Filecoin implementation unfolds into the following packages: + +- [This repo](https://github.com/filecoin-project/lotus) +- [lotus-docs](https://github.com/filecoin-project/lotus-docs) +- [go-fil-markets](https://github.com/filecoin-project/go-fil-markets) +- [go-storage-market](https://github.com/filecoin-project/go-storage-market) +- [go-storage-miner](https://github.com/filecoin-project/go-storage-miner) +- [storage-fsm](https://github.com/filecoin-project/storage-fsm) +- [sector-storage](https://github.com/filecoin-project/sector-storage) +- [specs-storage](https://github.com/filecoin-project/specs-storage) +- [spec-actors](https://github.com/filecoin-project/specs-actors) which has its own [kanban work tracker](https://app.zenhub.com/workspaces/actors-5ee6f3aa87591f0016c05685/board) + ## License Dual-licensed under [MIT](https://github.com/filecoin-project/lotus/blob/master/LICENSE-MIT) + [Apache 2.0](https://github.com/filecoin-project/lotus/blob/master/LICENSE-APACHE)