Skip to content

Commit 1ba176b

Browse files
authored
edit README (#16)
1 parent b8bce69 commit 1ba176b

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,23 @@
8181

8282
## About The Project
8383

84+
![client-flow][client-flow]
85+
8486
[![Product Name Screen Shot][product-screenshot]](https://www.flock.io)
8587

88+
This new FLock client interface boasts a state-of-the-art graphical user interface (GUI), offering a seamless and user-friendly platform for our esteemed users. The client, elegantly wrapped in ```Electron```, enables users to effortlessly engage with FLock's diverse features and functionalities through a visually appealing and intuitive interface. These features include:
89+
90+
- Communicate with a smart contract on a blockchain
91+
- Interact with IPFS for uploading and downloading model parameters
92+
- Automatically stake of tokens based on the current threshold
93+
- Participate in a federated learning system with a clear voting and proposing mechanism
94+
- Flexible with any model that implements the required interface
95+
- Handle training and evaluation of the models
96+
97+
You may download the desktop client of the lastest version [here](https://github.com/FLock-io/client-interface/releases/tag/v0.0.3).
98+
99+
For more detailed technical explanation of the FLock client, see [here](https://docs.flock.io/core-technologies/flock-client/client-deepdown).
100+
86101
<p align="right">(<a href="#readme-top">back to top</a>)</p>
87102

88103
### Built With
@@ -197,6 +212,7 @@ Use this space to list resources you find helpful and would like to give credit
197212
<!-- MARKDOWN LINKS & IMAGES -->
198213
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
199214

215+
[client-flow]: client-flow.png
200216
[contributors-shield]: https://img.shields.io/github/contributors/flock-io/client-interface.svg?style=for-the-badge
201217
[contributors-url]: https://github.com/flock-io/client-interface/graphs/contributors
202218
[forks-shield]: https://img.shields.io/github/forks/flock-io/client-interface.svg?style=for-the-badge

client-flow.png

570 KB
Loading

0 commit comments

Comments
 (0)